Packages

final class ZPipeline[-Env, +Err, -In, +Out] extends AnyRef

A ZPipeline[Env, Err, In, Out] is a polymorphic stream transformer. Pipelines accept a stream as input, and return the transformed stream as output.

Pipelines can be thought of as a recipe for calling a bunch of methods on a source stream, to yield a new (transformed) stream. A nice mental model is the following type alias:

type ZPipeline[Env, Err, In, Out] = ZStream[Env, Err, In] => ZStream[Env, Err, Out]

This encoding of a pipeline with a type alias is not used because it does not infer well. In its place, this trait captures the polymorphism inherent to many pipelines, which can therefore be more flexible about the environment and error types of the streams they transform.

There is no fundamental requirement for pipelines to exist, because everything pipelines do can be done directly on a stream. However, because pipelines separate the stream transformation from the source stream itself, it becomes possible to abstract over stream transformations at the level of values, creating, storing, and passing around reusable transformation pipelines that can be applied to many different streams.

The most common way to create a pipeline is to convert a sink into a pipeline (in general, transforming elements of a stream requires the power of a sink). However, the companion object has lots of other pipeline constructors based on the methods of stream.

Self Type
ZPipeline[Env, Err, In, Out]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZPipeline
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def <<<[Env1 <: Env, Err1 >: Err, In2](that: => ZPipeline[Env1, Err1, In2, In])(implicit trace: Trace): ZPipeline[Env1, Err1, In2, Out]

    Composes two pipelines into one pipeline, by first applying the transformation of the specified pipeline, and then applying the transformation of this pipeline.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def >>>[Env1 <: Env, Err1 >: Err, Leftover, Out2](that: => ZSink[Env1, Err1, Out, Leftover, Out2])(implicit trace: Trace): ZSink[Env1, Err1, In, Leftover, Out2]

    Compose this pipeline with a sink, resulting in a sink that processes elements by piping them through this pipeline and piping the results into the sink.

  6. def >>>[Env1 <: Env, Err1 >: Err, Out2](that: => ZPipeline[Env1, Err1, Out, Out2])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out2]

    Composes two pipelines into one pipeline, by first applying the transformation of this pipeline, and then applying the transformation of the specified pipeline.

  7. def aggregateAsync[Env1 <: Env, Err1 >: Err, Out1 >: Out, Out2](sink: ZSink[Env1, Err1, Out1, Out1, Out2])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out2]

    Aggregates elements of this stream using the provided sink for as long as the downstream operators on the stream are busy.

    Aggregates elements of this stream using the provided sink for as long as the downstream operators on the stream are busy.

    This operator divides the stream into two asynchronous "islands". Operators upstream of this operator run on one fiber, while downstream operators run on another. Whenever the downstream fiber is busy processing elements, the upstream fiber will feed elements into the sink until it signals completion.

    Any sink can be used here, but see ZSink.foldWeightedZIO and ZSink.foldUntilZIO for sinks that cover the common usecases.

  8. def aggregateAsyncWithin[Env1 <: Env, Err1 >: Err, Out1 >: Out, Out2](sink: ZSink[Env1, Err1, Out1, Out1, Out2], schedule: Schedule[Env1, Option[Out2], Any])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out2]

    Like aggregateAsyncWithinEither, but only returns the Right results.

  9. def aggregateAsyncWithinEither[Env1 <: Env, Err1 >: Err, Out1 >: Out, Out2, Out3](sink: ZSink[Env1, Err1, Out1, Out1, Out2], schedule: Schedule[Env1, Option[Out2], Out3])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Either[Out3, Out2]]

    Aggregates elements using the provided sink until it completes, or until the delay signalled by the schedule has passed.

    Aggregates elements using the provided sink until it completes, or until the delay signalled by the schedule has passed.

    This operator divides the stream into two asynchronous islands. Operators upstream of this operator run on one fiber, while downstream operators run on another. Elements will be aggregated by the sink until the downstream fiber pulls the aggregated value, or until the schedule's delay has passed.

    Aggregated elements will be fed into the schedule to determine the delays between pulls.

  10. def andThen[Env1 <: Env, Err1 >: Err, Out2](that: => ZPipeline[Env1, Err1, Out, Out2])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out2]

    A named version of the >>> operator.

  11. def apply[Env1 <: Env, Err1 >: Err](stream: => ZStream[Env1, Err1, In])(implicit trace: Trace): ZStream[Env1, Err1, Out]

    Attach this pipeline to the given stream

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def changes(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Returns a new pipeline that only emits elements that are not equal to the previous element emitted, using natural equality to determine whether two elements are equal.

  14. def changesWith(f: (Out, Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Returns a new pipeline that only emits elements that are not equal to the previous element emitted, using the specified function to determine whether two elements are equal.

  15. def changesWithZIO(f: (Out, Out) => UIO[Boolean])(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Returns a new pipeline that only emits elements that are not equal to the previous element emitted, using the specified effectual function to determine whether two elements are equal.

  16. val channel: ZChannel[Env, ZNothing, Chunk[In], Any, Err, Chunk[Out], Any]
  17. def chunks(implicit trace: Trace): ZPipeline[Env, Err, In, Chunk[Out]]

    Exposes the underlying chunks of the stream as a stream of chunks of elements.

  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  19. def collect[Out2](pf: PartialFunction[Out, Out2])(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Performs a filter and map in a single step.

  20. def collectLeft[A, B](implicit ev: <:<[Out, Either[A, B]], trace: Trace): ZPipeline[Env, Err, In, A]

    Filters any Right values.

  21. def collectRight[A, B](implicit ev: <:<[Out, Either[A, B]], trace: Trace): ZPipeline[Env, Err, In, B]

    Filters any Left values.

  22. def collectSome[Out2](implicit ev: <:<[Out, Option[Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Filters any 'None' values.

  23. def collectSuccess[Out2, L1](implicit ev: <:<[Out, Exit[L1, Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Filters any Exit.Failure values.

  24. def collectWhile[Out2](pf: PartialFunction[Out, Out2])(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Transforms all elements of the pipeline for as long as the specified partial function is defined.

  25. def collectWhileLeft[A, B](implicit ev: <:<[Out, Either[A, B]], trace: Trace): ZPipeline[Env, Err, In, A]

    Terminates the pipeline when encountering the first Right.

  26. def collectWhileRight[A, B](implicit ev: <:<[Out, Either[A, B]], trace: Trace): ZPipeline[Env, Err, In, B]

    Terminates the pipeline when encountering the first Left.

  27. def collectWhileSome[Out2](implicit ev: <:<[Out, Option[Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Terminates the pipeline when encountering the first None.

  28. def collectWhileSuccess[Err2, Out2](implicit ev: <:<[Out, Exit[Err2, Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Terminates the pipeline when encountering the first Exit.Failure.

  29. def collectWhileZIO[Env2 <: Env, Err2 >: Err, Out2](pf: PartialFunction[Out, ZIO[Env2, Err2, Out2]])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Effectfully transforms all elements of the pipeline for as long as the specified partial function is defined.

  30. def compose[Env1 <: Env, Err1 >: Err, In2](that: => ZPipeline[Env1, Err1, In2, In])(implicit trace: Trace): ZPipeline[Env1, Err1, In2, Out]

    A named version of the <<< operator.

  31. def contramap[In2](f: (In2) => In)(implicit trace: Trace): ZPipeline[Env, Err, In2, Out]

    Returns a new pipeline which is the same as this one but applies the given function to the pipeline's input.

  32. def dimap[In2, Out2](f: (In2) => In, g: (Out) => Out2)(implicit trace: Trace): ZPipeline[Env, Err, In2, Out2]

    Transforms the input and output types of this pipeline using the specified functions.

  33. def drain(implicit trace: Trace): ZPipeline[Env, Err, In, Nothing]

    Converts this pipeline to a pipeline that executes its effects but emits no elements.

    Converts this pipeline to a pipeline that executes its effects but emits no elements. Useful for sequencing effects using pipeline:

    (Stream(1, 2, 3).tap(i => ZIO(println(i))) ++
  (Stream.fromZIO(ZIO(println("Done!"))) >>> ZPipeline.drain) ++
  Stream(4, 5, 6).tap(i => ZIO(println(i)))).run(Sink.drain)
  34. def drop(n: => Int)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Drops the specified number of elements from this stream.

  35. def dropRight(n: => Int)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Drops the last specified number of elements from this pipeline.

    Drops the last specified number of elements from this pipeline.

    Note

    This combinator keeps n elements in memory. Be careful with big numbers.

  36. def dropUntil(f: (Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Drops all elements of the pipeline until the specified predicate evaluates to true.

  37. def dropUntilZIO[Env1 <: Env, Err1 >: Err](f: (Out) => ZIO[Env1, Err1, Boolean])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out]

    Drops incoming elements until the effectful predicate p is satisfied.

  38. def dropWhile(f: (Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Drops all elements of the pipeline for as long as the specified predicate evaluates to true.

  39. def dropWhileZIO[Env1 <: Env, Err1 >: Err](f: (Out) => ZIO[Env1, Err1, Boolean])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out]

    Drops incoming elements as long as the effectful predicate p is satisfied.

  40. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  42. def filter(f: (Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Filters the elements emitted by this pipeline using the provided function.

  43. def filterZIO[Env2 <: Env, Err2 >: Err](f: (Out) => ZIO[Env2, Err2, Boolean])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out]

    Effectfully filters the elements emitted by this pipeline.

  44. def flattenChunks[Out2](implicit ev: <:<[Out, Chunk[Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Submerges the chunks carried by this pipeline into the pipeline's structure, while still preserving them.

  45. def flattenExit[Err2, Out2](implicit ev: <:<[Out, Exit[Err2, Out2]], trace: Trace): ZPipeline[Env, Err2, In, Out2]

    Flattens Exit values.

    Flattens Exit values. Exit.Failure values translate to pipeline failures while Exit.Success values translate to stream elements.

  46. def flattenIterables[Out2](implicit ev: <:<[Out, Iterable[Out2]], trace: Trace): ZPipeline[Env, Err, In, Out2]

    Submerges the iterables carried by this pipeline into the pipeline's structure, while still preserving them.

  47. def flattenTake[Err1 >: Err, Out2](implicit ev: <:<[Out, Take[Err1, Out2]], trace: Trace): ZPipeline[Env, Err1, In, Out2]

    Flattens take values.

  48. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def grouped(chunkSize: => Int)(implicit trace: Trace): ZPipeline[Env, Err, In, Chunk[Out]]

    Partitions the pipeline with specified chunkSize

    Partitions the pipeline with specified chunkSize

    chunkSize

    size of the chunk

  50. def groupedWithin(chunkSize: => Int, within: => zio.Duration)(implicit trace: Trace): ZPipeline[Env, Err, In, Chunk[Out]]

    Partitions the stream with the specified chunkSize or until the specified duration has passed, whichever is satisfied first.

  51. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def intersperse[Out2 >: Out](start: => Out2, middle: => Out2, end: => Out2)(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Intersperse and also add a prefix and a suffix

  53. def intersperse[Out2 >: Out](middle: => Out2)(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Intersperse pipeline with provided element similar to List.mkString.

  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def map[Out2](f: (Out) => Out2)(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Transforms the elements of this pipeline using the supplied function.

  56. def mapAccum[State, Out2](s: => State)(f: (State, Out) => (State, Out2))(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Statefully maps over the elements of this pipeline to produce new elements.

  57. def mapAccumZIO[Env2 <: Env, Err2 >: Err, State, Out2](s: => State)(f: (State, Out) => ZIO[Env2, Err2, (State, Out2)])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Statefully and effectfully maps over the elements of this pipeline to produce new elements.

  58. def mapChunks[Out2](f: (Chunk[Out]) => Chunk[Out2])(implicit trace: Trace): ZPipeline[Env, Err, In, Out2]

    Transforms the chunks emitted by this stream.

  59. def mapChunksZIO[Env2 <: Env, Err2 >: Err, Out2](f: (Chunk[Out]) => ZIO[Env2, Err2, Chunk[Out2]])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Creates a pipeline that maps chunks of elements with the specified effect.

  60. def mapError[Err2](f: (Err) => Err2)(implicit trace: Trace): ZPipeline[Env, Err2, In, Out]

    Transforms the errors emitted by this pipeline using f.

  61. def mapErrorCause[Err2](f: (Cause[Err]) => Cause[Err2])(implicit trace: Trace): ZPipeline[Env, Err2, In, Out]

    A more powerful version of mapError which also surfaces the Cause of the channel failure

  62. def mapErrorZIO[Env1 <: Env, Err2](f: (Err) => URIO[Env1, Err2])(implicit trace: Trace): ZPipeline[Env1, Err2, In, Out]

    Transforms the errors emitted by this pipeline using f.

  63. def mapStream[Env2 <: Env, Err2 >: Err, Out2](f: (Out) => ZStream[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Creates a pipeline that maps elements with the specified function that returns a stream.

  64. def mapZIO[Env2 <: Env, Err2 >: Err, Out2](f: (Out) => ZIO[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Creates a pipeline that maps elements with the specified effectful function.

  65. def mapZIOPar[Env2 <: Env, Err2 >: Err, Out2](n: => Int, bufferSize: => Int = 16)(f: (Out) => ZIO[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]
  66. def mapZIOPar[Env2 <: Env, Err2 >: Err, Out2](n: => Int)(f: (Out) => ZIO[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently.

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently. Transformed elements will be emitted in the original order.

    Note

    This combinator destroys the chunking structure. It's recommended to use rechunk afterwards.

  67. def mapZIOParUnordered[Env2 <: Env, Err2 >: Err, Out2](n: => Int, bufferSize: => Int = 16)(f: (Out) => ZIO[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently.

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently. The element order is not enforced by this combinator, and elements may be reordered.

  68. def mapZIOParUnordered[Env2 <: Env, Err2 >: Err, Out2](n: => Int)(f: (Out) => ZIO[Env2, Err2, Out2])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out2]

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently.

    Maps over elements of the stream with the specified effectful function, executing up to n invocations of f concurrently. The element order is not enforced by this combinator, and elements may be reordered.

  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. def orDie(implicit ev: <:<[Err, Throwable], trace: Trace): ZPipeline[Env, Nothing, In, Out]

    Translates pipeline failure into death of the fiber, making all failures unchecked and not a part of the type of the effect.

  73. def orDieWith(f: (Err) => Throwable)(implicit trace: Trace): ZPipeline[Env, Nothing, In, Out]

    Keeps none of the errors, and terminates the fiber with them, using the specified function to convert the E into a Throwable.

  74. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  75. def take(n: => Long)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Takes the specified number of elements from this pipeline.

  76. def takeUntil(f: (Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Takes all elements of the pipeline until the specified predicate evaluates to true.

  77. def takeUntilZIO[Env1 <: Env, Err1 >: Err](f: (Out) => ZIO[Env1, Err1, Boolean])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out]

    Takes all elements of the pipeline until the specified effectual predicate evaluates to true.

  78. def takeWhile(f: (Out) => Boolean)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Takes all elements of the pipeline for as long as the specified predicate evaluates to true.

  79. def takeWhileZIO[Env1 <: Env, Err1 >: Err](f: (Out) => ZIO[Env1, Err1, Boolean])(implicit trace: Trace): ZPipeline[Env1, Err1, In, Out]

    Takes all elements of the pipeline for as long as the specified effectual predicate evaluates to true.

  80. def tap[Env2 <: Env, Err2 >: Err](f: (Out) => ZIO[Env2, Err2, Any])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out]

    Adds an effect to consumption of every element of the pipeline.

  81. def throttleEnforce(units: Long, duration: => zio.Duration, burst: => Long = 0)(costFn: (Chunk[Out]) => Long)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Throttles the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm.

    Throttles the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. Chunks that do not meet the bandwidth constraints are dropped. The weight of each chunk is determined by the costFn function.

  82. def throttleEnforceZIO[Env2 <: Env, Err2 >: Err](units: => Long, duration: => zio.Duration, burst: => Long = 0)(costFn: (Chunk[Out]) => ZIO[Env2, Err2, Long])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out]

    Throttles the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm.

    Throttles the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. Chunks that do not meet the bandwidth constraints are dropped. The weight of each chunk is determined by the costFn effectful function.

  83. def throttleShape(units: => Long, duration: => zio.Duration, burst: Long = 0)(costFn: (Chunk[Out]) => Long)(implicit trace: Trace): ZPipeline[Env, Err, In, Out]

    Delays the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm.

    Delays the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. The weight of each chunk is determined by the costFn function.

  84. def throttleShapeZIO[Env2 <: Env, Err2 >: Err](units: => Long, duration: => zio.Duration, burst: => Long = 0)(costFn: (Chunk[Out]) => ZIO[Env2, Err2, Long])(implicit trace: Trace): ZPipeline[Env2, Err2, In, Out]

    Delays the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm.

    Delays the chunks of this pipeline according to the given bandwidth parameters using the token bucket algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. The weight of each chunk is determined by the costFn effectful function.

  85. def toChannel: ZChannel[Env, ZNothing, Chunk[In], Any, Err, Chunk[Out], Any]

    Converts this pipeline to its underlying channel

  86. def toString(): String
    Definition Classes
    AnyRef → Any
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  89. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  90. def zipWithIndex(implicit trace: Trace): ZPipeline[Env, Err, In, (Out, Long)]

    Zips this pipeline together with the index of elements.

  91. def zipWithNext(implicit trace: Trace): ZPipeline[Env, Err, In, (Out, Option[Out])]
  92. def zipWithPrevious(implicit trace: Trace): ZPipeline[Env, Err, In, (Option[Out], Out)]
  93. def zipWithPreviousAndNext(implicit trace: Trace): ZPipeline[Env, Err, In, (Option[Out], Out, Option[Out])]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped