Sink76

Constructors

collectconstAccumulates incoming elements into an array.countconstA sink that counts the number of elements fed to it.dieconstCreates a sink halting with a specified defect.drainconstConsumes and ignores all stream inputs.everyconstA sink that returns whether all elements satisfy the specified predicate.failconstA sink that always fails with the specified error.failCauseconstCreates a sink halting with a specified Cause.failCauseSyncconstCreates a sink halting with a specified lazily evaluated Cause.failSyncconstA sink that always fails with the specified lazily evaluated error.findconstCreates a sink containing the first value matched by a synchronous predicate.findEffectconstCreates a sink containing the first value matched by an effectful predicate.forEachconstA sink that executes the provided effectful function for every item fed to it.forEachArrayconstA sink that executes the provided effectful function for every Chunk fed to it.forEachWhileconstRuns an effectful function for each input element while it returns true.forEachWhileArrayconstRuns an effectful function for each non-empty input array while it returns true.fromChannelconstCreates a sink from a Channel.fromEffectconstCreates a sink that ignores upstream input and completes with the success value of the provided effect.fromEffectEndconstCreates a sink that ignores upstream input and completes from an effect that already returns an End.fromPubSubconstCreates a sink that publishes every consumed input element to a PubSub.fromQueueconstCreates a sink that offers every consumed input element to a queue.fromTransformconstCreates a Sink from a low-level transform function.headconstCreates a sink containing the first value.lastconstCreates a sink containing the last value.makenamespaceCreates a pipe-style constructor for sinks over input type In.neverconstA sink that never completes.someconstA sink that returns whether an element satisfies the specified predicate.succeedconstA sink that immediately ends with the specified value.sumconstCreates a sink which sums up its inputs.suspendconstA sink that is created from a lazily evaluated sink.syncconstA sink that immediately ends with the specified lazily evaluated value.takeUntilconstCollects input elements until the predicate returns true, including the matching element in the result.takeUntilEffectconstCollects input elements effectfully until the predicate returns true, including the matching element in the result.takeWhileconstCollects the longest input prefix whose elements satisfy the predicate or refinement.takeWhileEffectconstCollects input elements effectfully while the predicate succeeds.takeWhileFilterconstApplies a Filter to input elements while it succeeds, collecting each successful output.takeWhileFilterEffectconstApplies a FilterEffect to input elements effectfully while it succeeds, collecting each successful output.timedconstA sink that drains all input and returns the elapsed duration.toChannelconstCreates a Channel from a Sink.unwrapconstCreates a sink produced from a scoped effect.

Services

provideContextconstProvides a Context to this sink.provideServiceconstProvides a single service implementation to this sink.

Models

EndtypeTuple returned when a Sink finishes.SinkinterfaceA Sink<A, In, L, E, R> is used to consume elements produced by a Stream.SinkUnifyinterfaceType-level unification support for Sink values.SinkUnifyIgnoreinterfaceMarker used by Effect's Unify machinery for Sink values.

Guards

isSinkconstChecks whether a value is a Sink.

Mapping

asconstSets the sink's result to a constant value.mapconstTransforms this sink's result.mapEffectconstTransforms this sink's result effectfully.mapEffectEndconstTransforms the full End produced by this sink effectfully.mapEndconstTransforms the full End produced by this sink.mapErrorconstTransforms the errors emitted by this sink using f.mapInputconstTransforms this sink's input elements.mapInputArrayconstTransforms each non-empty array of upstream input before it is fed to this sink.mapInputArrayEffectconstTransforms each non-empty array of upstream input effectfully before it is fed to this sink.mapInputEffectconstTransforms this sink's input elements effectfully.mapLeftoverconstTransforms the leftovers emitted by this sink using f.summarizedconstRuns a summary effect when the sink starts and again when it completes.withDurationconstReturns the sink that executes this one and times its execution.

Filtering

ignoreLeftoverconstDrops leftovers produced by a sink.

Sequencing

flatMapconstRuns this sink until it yields a result, then uses that result to create another sink from the provided function which will continue to run until it yields a result.

Collecting

takeconstCollects up to n input elements into an array.

Error Handling

catchCauseconstHandles failures from this sink by inspecting the full Cause.orElseconstRuns a fallback sink if this sink fails with a typed error.

Finalization

ensuringconstRuns a finalizer effect after this sink completes, fails, or is interrupted.onExitconstRuns an effect after this sink completes, fails, or is interrupted.

Folding

foldconstA sink that folds its inputs with the provided function, termination predicate and initial state.foldArrayconstFolds non-empty input arrays into state with an effectful function.foldUntilconstFolds input elements into state until the specified maximum number of elements has been consumed or the upstream stream ends.

Reducing

reduceconstA sink that reduces its inputs using the provided function f starting from the provided initial state.reduceArrayconstA sink that reduces its inputs using the provided function f starting from the specified initial state.reduceEffectconstA sink that reduces its inputs using the provided effectful function f starting from the specified initial state.reduceWhileconstA sink that reduces input elements from the provided initial state with f while the specified predicate returns true.reduceWhileArrayconstA sink that reduces non-empty input arrays from the provided initial state with f while the specified predicate returns true.reduceWhileArrayEffectconstA sink that effectfully reduces non-empty input arrays from the provided initial state with f while the specified predicate returns true.reduceWhileEffectconstA sink that effectfully reduces input elements from the provided initial state with f while the specified predicate returns true.