zio-streams/zio.stream/ZSink

ZSink

final class ZSink[-R, +E, -In, +L, +Z](val channel: ZChannel[R, ZNothing, Chunk[In], Any, E, Chunk[L], Z]) extends AnyVal
Companion:
object
class AnyVal
trait Matchable
class Any
ZSink[R, E, In, L, Z]

Value members

Concrete methods

final def &>[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Operator alias for zipParRight.

Operator alias for zipParRight.

final def *>[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Operator alias for zipRight.

Operator alias for zipRight.

final def <&[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z]

Operator alias for zipParLeft.

Operator alias for zipParLeft.

final def <&>[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit zippable: Zippable[Z, Z1], trace: Trace): ZSink[R1, E1, In1, L1, Out]

Operator alias for zipPar.

Operator alias for zipPar.

final def <*[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z]

Operator alias for zipLeft.

Operator alias for zipLeft.

final def <*>[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit zippable: Zippable[Z, Z1], ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Out]

Operator alias for zip.

Operator alias for zip.

def as[Z2](z: => Z2)(implicit trace: Trace): ZSink[R, E, In, L, Z2]

Replaces this sink's result with the provided value.

Replaces this sink's result with the provided value.

def collectAllWhileWith[S](z: => S)(p: Z => Boolean)(f: (S, Z) => S)(implicit ev: L <:< In, trace: Trace): ZSink[R, E, In, L, S]

Repeatedly runs the sink for as long as its results satisfy the predicate p. The sink's results will be accumulated using the stepping function f.

Repeatedly runs the sink for as long as its results satisfy the predicate p. The sink's results will be accumulated using the stepping function f.

def contramap[In1](f: In1 => In)(implicit trace: Trace): ZSink[R, E, In1, L, Z]

Transforms this sink's input elements.

Transforms this sink's input elements.

def contramapChunks[In1](f: Chunk[In1] => Chunk[In])(implicit trace: Trace): ZSink[R, E, In1, L, Z]

Transforms this sink's input chunks. f must preserve chunking-invariance

Transforms this sink's input chunks. f must preserve chunking-invariance

def contramapChunksZIO[R1 <: R, E1 >: E, In1](f: Chunk[In1] => ZIO[R1, E1, Chunk[In]])(implicit trace: Trace): ZSink[R1, E1, In1, L, Z]

Effectfully transforms this sink's input chunks. f must preserve chunking-invariance

Effectfully transforms this sink's input chunks. f must preserve chunking-invariance

def contramapZIO[R1 <: R, E1 >: E, In1](f: In1 => ZIO[R1, E1, In])(implicit trace: Trace): ZSink[R1, E1, In1, L, Z]

Effectfully transforms this sink's input elements.

Effectfully transforms this sink's input elements.

def dimap[In1, Z1](f: In1 => In, g: Z => Z1)(implicit trace: Trace): ZSink[R, E, In1, L, Z1]

Transforms both inputs and result of this sink using the provided functions.

Transforms both inputs and result of this sink using the provided functions.

def dimapChunks[In1, Z1](f: Chunk[In1] => Chunk[In], g: Z => Z1)(implicit trace: Trace): ZSink[R, E, In1, L, Z1]

Transforms both input chunks and result of this sink using the provided functions.

Transforms both input chunks and result of this sink using the provided functions.

def dimapChunksZIO[R1 <: R, E1 >: E, In1, Z1](f: Chunk[In1] => ZIO[R1, E1, Chunk[In]], g: Z => ZIO[R1, E1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L, Z1]

Effectfully transforms both input chunks and result of this sink using the provided functions. f and g must preserve chunking-invariance

Effectfully transforms both input chunks and result of this sink using the provided functions. f and g must preserve chunking-invariance

def dimapZIO[R1 <: R, E1 >: E, In1, Z1](f: In1 => ZIO[R1, E1, In], g: Z => ZIO[R1, E1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L, Z1]

Effectfully transforms both inputs and result of this sink using the provided functions.

Effectfully transforms both inputs and result of this sink using the provided functions.

def dropLeftover(implicit trace: Trace): ZSink[R, E, In, Nothing, Z]
def exposeLeftover(implicit trace: Trace): ZSink[R, E, In, Nothing, (Z, Chunk[L])]
def filterInput[In1 <: In](p: In1 => Boolean)(implicit trace: Trace): ZSink[R, E, In1, L, Z]
def filterInputZIO[R1 <: R, E1 >: E, In1 <: In](p: In1 => ZIO[R1, E1, Boolean])(implicit trace: Trace): ZSink[R1, E1, In1, L, Z]
def flatMap[R1 <: R, E1 >: E, In1 <: In, L1 >: L <: In1, Z1](f: Z => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Runs 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.

Runs 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.

This function essentially runs sinks in sequence.

def foldSink[R1 <: R, E2, In1 <: In, L1 >: L <: In1, Z1](failure: E => ZSink[R1, E2, In1, L1, Z1], success: Z => ZSink[R1, E2, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E2, In1, L1, Z1]
def map[Z2](f: Z => Z2)(implicit trace: Trace): ZSink[R, E, In, L, Z2]

Transforms this sink's result.

Transforms this sink's result.

def mapError[E2](f: E => E2)(implicit trace: Trace): ZSink[R, E2, In, L, Z]

Transforms the errors emitted by this sink using f.

Transforms the errors emitted by this sink using f.

def mapZIO[R1 <: R, E1 >: E, Z1](f: Z => ZIO[R1, E1, Z1])(implicit trace: Trace): ZSink[R1, E1, In, L, Z1]

Effectfully transforms this sink's result.

Effectfully transforms this sink's result.

def orElse[R1 <: R, In1 <: In, E2 >: E, L1 >: L, Z1 >: Z](that: => ZSink[R1, E2, In1, L1, Z1])(implicit trace: Trace): ZSink[R1, E2, In1, L1, Z1]
def provideEnvironment(r: => ZEnvironment[R])(implicit trace: Trace): ZSink[Any, E, In, L, Z]

Provides the sink with its required environment, which eliminates its dependency on R.

Provides the sink with its required environment, which eliminates its dependency on R.

final def race[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L, Z1 >: Z](that: => ZSink[R1, E1, In1, L1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Runs both sinks in parallel on the input, , returning the result or the error from the one that finishes first.

Runs both sinks in parallel on the input, , returning the result or the error from the one that finishes first.

final def raceBoth[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L, Z2](that: => ZSink[R1, E1, In1, L1, Z2], capacity: => Int)(implicit trace: Trace): ZSink[R1, E1, In1, L1, Either[Z, Z2]]

Runs both sinks in parallel on the input, returning the result or the error from the one that finishes first.

Runs both sinks in parallel on the input, returning the result or the error from the one that finishes first.

final def raceWith[R1 <: R, E1 >: E, A0, In1 <: In, L1 >: L, Z1, Z2](that: => ZSink[R1, E1, In1, L1, Z1], capacity: => Int)(leftDone: Exit[E, Z] => MergeDecision[R1, E1, Z1, E1, Z2], rightDone: Exit[E1, Z1] => MergeDecision[R1, E, Z, E1, Z2])(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z2]

Runs both sinks in parallel on the input, using the specified merge function as soon as one result or the other has been computed.

Runs both sinks in parallel on the input, using the specified merge function as soon as one result or the other has been computed.

def repeat(implicit ev: L <:< In, trace: Trace): ZSink[R, E, In, L, Chunk[Z]]
def splitWhere[In1 <: In](f: In1 => Boolean)(implicit ev: L <:< In1, trace: Trace): ZSink[R, E, In1, In1, Z]

Splits the sink on the specified predicate, returning a new sink that consumes elements until an element after the first satisfies the specified predicate.

Splits the sink on the specified predicate, returning a new sink that consumes elements until an element after the first satisfies the specified predicate.

final def summarized[R1 <: R, E1 >: E, B, C](summary: => ZIO[R1, E1, B])(f: (B, B) => C)(implicit trace: Trace): ZSink[R1, E1, In, L, (Z, C)]

Summarize a sink by running an effect when the sink starts and again when it completes

Summarize a sink by running an effect when the sink starts and again when it completes

final def timed(implicit trace: Trace): ZSink[R, E, In, L, (Z, Duration)]

Returns the sink that executes this one and times its execution.

Returns the sink that executes this one and times its execution.

def untilOutputZIO[R1 <: R, E1 >: E](f: Z => ZIO[R1, E1, Boolean])(implicit ev: L <:< In, trace: Trace): ZSink[R1, E1, In, L, Option[Z]]

Creates a sink that produces values until one verifies the predicate f.

Creates a sink that produces values until one verifies the predicate f.

def zip[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit zippable: Zippable[Z, Z1], ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Out]
final def zipLeft[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z]

Like zip, but keeps only the result from the that sink.

Like zip, but keeps only the result from the that sink.

final def zipPar[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit zippable: Zippable[Z, Z1], trace: Trace): ZSink[R1, E1, In1, L1, Out]

Runs both sinks in parallel on the input and combines the results in a tuple.

Runs both sinks in parallel on the input and combines the results in a tuple.

final def zipParLeft[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z]

Like zipPar, but keeps only the result from this sink.

Like zipPar, but keeps only the result from this sink.

final def zipParRight[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Like zipPar, but keeps only the result from the that sink.

Like zipPar, but keeps only the result from the that sink.

final def zipRight[R1 <: R, In1 <: In, E1 >: E, L1 >: L <: In1, Z1](that: => ZSink[R1, E1, In1, L1, Z1])(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Like zip, but keeps only the result from this sink.

Like zip, but keeps only the result from this sink.

final def zipWith[R1 <: R, E1 >: E, In1 <: In, L1 >: L <: In1, Z1, Z2](that: => ZSink[R1, E1, In1, L1, Z1])(f: (Z, Z1) => Z2)(implicit ev: L <:< In1, trace: Trace): ZSink[R1, E1, In1, L1, Z2]

Feeds inputs to this sink until it yields a result, then switches over to the provided sink until it yields a result, finally combining the two results with f.

Feeds inputs to this sink until it yields a result, then switches over to the provided sink until it yields a result, finally combining the two results with f.

final def zipWithPar[R1 <: R, E1 >: E, In1 <: In, L1 >: L <: In1, Z1, Z2](that: => ZSink[R1, E1, In1, L1, Z1])(f: (Z, Z1) => Z2)(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z2]

Runs both sinks in parallel on the input and combines the results using the provided function.

Runs both sinks in parallel on the input and combines the results using the provided function.

final def |[R1 <: R, E1 >: E, In1 <: In, L1 >: L, Z1 >: Z](that: => ZSink[R1, E1, In1, L1, Z1])(implicit trace: Trace): ZSink[R1, E1, In1, L1, Z1]

Operator alias for race.

Operator alias for race.

Concrete fields

val channel: ZChannel[R, ZNothing, Chunk[In], Any, E, Chunk[L], Z]