ZChannel
Related Docs:
object ZChannel
| package stream
Returns a new channel that is the sequential composition of this channel and the specified channel.
Returns a new channel that is the sequential composition of this channel and the specified channel. The returned channel terminates with the terminal value of the other channel.
This is a symbol operator for ZChannel#zipRight.
Returns a new channel that is the sequential composition of this channel and the specified channel.
Returns a new channel that is the sequential composition of this channel and the specified channel. The returned channel terminates with the terminal value of this channel.
This is a symbol operator for ZChannel#zipLeft.
Returns a new channel that is the sequential composition of this channel and the specified channel.
Returns a new channel that is the sequential composition of this channel and the specified channel. The returned channel terminates with a tuple of the terminal values of both channels.
This is a symbol operator for ZChannel#zip.
Returns a new channel that pipes the output of this channel into the specified channel.
Returns a new channel that pipes the output of this channel into the specified channel. The returned channel has the input type of this channel, and the output type of the specified channel, terminating with the value of the specified channel.
This is a symbolic operator for ZChannel#pipeTo.
Returns a new channel that is the same as this one, except the terminal value of the channel is the specified constant value.
Returns a new channel that is the same as this one, except the terminal value of the channel is the specified constant value.
This method produces the same result as mapping this channel to the specified constant value.
Returns a new channel that is the same as this one, except if this channel errors for any typed error, then the returned channel will switch over to using the fallback channel returned by the specified error handler.
Returns a new channel that is the same as this one, except if this channel errors for any cause at all, then the returned channel will switch over to using the fallback channel returned by the specified error handler.
Returns a new channel, which is the same as this one, except its outputs are filtered and transformed by the specified partial function.
Returns a new channel, which is the same as this one, except that all the outputs are collected and bundled into a tuple together with the terminal value of this channel.
Returns a new channel, which is the same as this one, except that all the outputs are collected and bundled into a tuple together with the terminal value of this channel.
As the channel returned from this channel collects all of this channel's output into an in- memory chunk, it is not safe to call this method on channels that output a large or unbounded number of values.
Returns a new channel whose outputs are fed to the specified factory function, which creates new channels in response.
Returns a new channel whose outputs are fed to the specified factory function, which creates new channels in response. These new channels are sequentially concatenated together, and all their outputs appear as outputs of the newly returned channel.
Returns a new channel whose outputs are fed to the specified factory function, which creates new channels in response.
Returns a new channel whose outputs are fed to the specified factory function, which creates new channels in response. These new channels are sequentially concatenated together, and all their outputs appear as outputs of the newly returned channel. The provided merging function is used to merge the terminal values of all channels into the single terminal value of the returned channel.
Returns a new channel, which is the concatenation of all the channels that are written out by this channel.
Returns a new channel, which is the concatenation of all the channels that are written out by this channel. This method may only be called on channels that output other channels.
Returns a new channel which is the same as this one but applies the given function to the input channel's done value.
Returns a new channel which is the same as this one but applies the given function to the input channel's error value.
Returns a new channel which is the same as this one but applies the given ZIO function to the input channel's error value.
Returns a new channel which is the same as this one but applies the given function to the input channel's output elements
Returns a new channel which is the same as this one but applies the given ZIO function to the input channel's output elements
Returns a new channel which is the same as this one but applies the given ZIO function to the input channel's done value.
Returns a new channel which reads all the elements from upstream's output channel and ignores them, then terminates with the upstream result value.
Returns a new channel that collects the output and terminal value of this channel, which it then writes as output of the returned channel.
Returns a new channel with an attached finalizer.
Returns a new channel with an attached finalizer. The finalizer is guaranteed to be executed so long as the channel begins execution (and regardless of whether or not it completes).
Returns a new channel with an attached finalizer.
Returns a new channel with an attached finalizer. The finalizer is guaranteed to be executed so long as the channel begins execution (and regardless of whether or not it completes).
Returns a new channel, which sequentially combines this channel, together with the provided factory function, which creates a second channel based on the terminal value of this channel.
Returns a new channel, which sequentially combines this channel, together with the provided factory function, which creates a second channel based on the terminal value of this channel. The result is a channel that will first perform the functions of this channel, before performing the functions of the created channel (including yielding its terminal value).
Returns a new channel, which flattens the terminal value of this channel.
Returns a new channel, which flattens the terminal value of this channel. This function may only be called if the terminal value of this channel is another channel of compatible types.
Folds over the result of this channel including any cause of termination
Folds over the result of this channel
Returns a new channel, which is the same as this one, except it will be interrupted when the specified promise is completed.
Returns a new channel, which is the same as this one, except it will be interrupted when the specified promise is completed. If the promise is completed before the underlying channel is done, then the returned channel will yield the value of the promise. Otherwise, if the underlying channel finishes first, then the returned channel will yield the value of the underlying channel.
Returns a new channel, which is the same as this one, except it will be interrupted when the specified effect completes.
Returns a new channel, which is the same as this one, except it will be interrupted when the specified effect completes. If the effect completes successfully before the underlying channel is done, then the returned channel will yield the success value of the effect as its terminal value. On the other hand, if the underlying channel finishes first, then the returned channel will yield the success value of the underlying channel as its terminal value.
Returns a new channel, which is the same as this one, except the terminal value of the returned channel is created by applying the specified function to the terminal value of this channel.
Returns a new channel, which is the same as this one, except the failure value of the returned channel is created by applying the specified function to the failure value of this channel.
A more powerful version of mapError which also surfaces the Cause of the channel failure
Creates a channel that is like this channel but the given function gets applied to each emitted output element
Creates a channel that is like this channel but the given ZIO function gets applied to each emitted output element
Creates a channel that is like this channel but the given ZIO function gets
applied to each emitted output element, taking n elements at once and
mapping them in parallel
Returns a new channel, which is the same as this one, except the terminal value of the returned channel is created by applying the specified effectful function to the terminal value of this channel.
Returns a new channel which creates a new channel for each emitted element and merges some of them together.
Returns a new channel which creates a new channel for each emitted element and merges some of them together. Different merge strategies control what happens if there are more than the given maximum number of channels gets created. See ZChannel.mergeAll.
The maximum number of channels to merge
Number of elements that can be buffered from upstream for the merging
Merge strategy, either back pressure or sliding.
The function that creates a new channel from each emitted element
Returns a new channel which merges a number of channels emitted by this channel using the back pressuring merge strategy.
Returns a new channel which merges a number of channels emitted by this channel using the back pressuring merge strategy. See ZChannel.mergeAll
Returns a new channel which merges a number of channels emitted by this channel using the back pressuring merge strategy and uses a given function to merge each completed subchannel's result value.
Returns a new channel which merges a number of channels emitted by this channel using the back pressuring merge strategy and uses a given function to merge each completed subchannel's result value. See ZChannel.mergeAll
Returns a new channel, which is the merge of this channel and the specified
channel, where the behavior of the returned channel on left or right early
termination is decided by the specified leftDone and rightDone merge
decisions.
Translates channel failure into death of the fiber, making all failures unchecked and not a part of the type of the channel.
Keeps none of the errors, and terminates the fiber with them, using the
specified function to convert the OutErr into a Throwable.
Returns a new channel that will perform the operations of this one, until failure, and then it will switch over to the operations of the specified fallback channel.
Returns a new channel that pipes the output of this channel into the specified channel.
Returns a new channel that pipes the output of this channel into the specified channel. The returned channel has the input type of this channel, and the output type of the specified channel, terminating with the value of the specified channel.
Same as the symbolic operator >>>
Returns a new channel that pipes the output of this channel into the specified channel and preserves this channel's failures without providing them to the other channel for observation.
Provides the channel with its required environment, which eliminates its
dependency on Env.
Provides a layer to the channel, which translates it to another level.
Transforms the environment being provided to the channel with the specified function.
Splits the environment into two parts, providing one part using the
specified layer and leaving the remainder Env0.
Creates a channel which repeatedly runs this channel
Run the channel until it finishes with a done value or fails with an error.
Run the channel until it finishes with a done value or fails with an error. The channel must not read any input or write any output.
Run the channel until it finishes with a done value or fails with an error and collects its emitted output elements.
Run the channel until it finishes with a done value or fails with an error and collects its emitted output elements.
The channel must not read any input.
Run the channel until it finishes with a done value or fails with an error and ignores its emitted output elements.
Run the channel until it finishes with a done value or fails with an error and ignores its emitted output elements.
The channel must not read any input.
Run the channel until it finishes with a done value or fails with an error.
Run the channel until it finishes with a done value or fails with an error. The channel must not read any input or write any output.
Closing the channel, which includes execution of all the finalizers attached to the channel will be added to the current scope as a finalizer.
Converts this channel to a ZPipeline
Returns in a scope a ZIO effect that can be used to repeatedly pull elements from the channel.
Returns in a scope a ZIO effect that can be used to repeatedly pull elements from the channel. The pull effect fails with the channel's failure in case the channel fails, or returns either the channel's done value or an emitted element.
Converts this channel to a ZSink
Converts this channel to a ZStream
Creates a new channel which is like this channel but returns with the unit value when succeeds
Updates a service in the environment of this channel.
Updates a service at the specified key in the environment of this channel.
Creates a new channel which first runs this channel and if it succeeds runs the other channel and finally finishes with the zipped done value of both channels
Creates a new channel which first runs this channel and if it succeeds runs the other channel and finally finishes with the done value of the first channel
Creates a new channel which runs in parallel this and the other channel and when both succeeds finishes with a tuple of both channel's done value
Creates a new channel which runs in parallel this and the other channel and when both succeeds finishes with the first one's done value
Creates a new channel which runs in parallel this and the other channel and when both succeeds finishes with the second one's done value
Creates a new channel which first runs this channel and if it succeeds runs the other channel and finally finishes with the done value of the second channel
A
ZChannel[Env, InErr, InElem, InDone, OutErr, OutElem, OutDone]is a nexus of I/O operations, which supports both reading and writing. A channel may read values of typeInElemor process upstream failures of typeInErr, while it may write values of typeOutElem. When the channel finishes, it yields a value of typeOutDone. A channel may fail with a value of typeOutErr.Channels are the foundation of ZIO Streams: both streams and sinks are built on channels. Most users shouldn't have to use channels directly, as streams and sinks are much more convenient and cover all common use cases. However, when adding new stream and sink operators, or doing something highly specialized, it may be useful to use channels directly.
Channels compose in a variety of ways: