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]
- Alphabetic
- By Inheritance
- ZPipeline
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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 transducer with a sink, resulting in a sink that processes elements by piping them through this transducer and piping the results into the sink.
- 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.
- 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. - 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val channel: ZChannel[Env, ZNothing, Chunk[In], Any, Err, Chunk[Out], Any]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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. - final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapError[Err2](f: (Err) => Err2)(implicit trace: Trace): ZPipeline[Env, Err2, In, Out]
Transforms the errors emitted by this pipeline using
f
. - 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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.
- 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 aThrowable
. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toChannel: ZChannel[Env, ZNothing, Chunk[In], Any, Err, Chunk[Out], Any]
Converts this pipeline to its underlying channel
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()