Class/Object

zio.stream

ZStream

Related Docs: object ZStream | package stream

Permalink

abstract class ZStream[-R, +E, +O] extends AnyRef

Self Type
ZStream[R, E, O]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZStream
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ZStream(process: ZManaged[R, Nothing, ZIO[R, Option[E], Chunk[O]]])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def &>[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Symbolic alias for ZStream#zipRight.

  4. final def *>[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Symbolic alias for ZStream#crossRight.

  5. def ++[R1 <: R, E1 >: E, O1 >: O](that: ⇒ ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Symbolic alias for ZStream#concat.

  6. final def <&[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O]

    Permalink

    Symbolic alias for ZStream#zipLeft.

  7. final def <&>[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, (O, O2)]

    Permalink

    Symbolic alias for ZStream#zip.

  8. final def <*[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O]

    Permalink

    Symbolic alias for ZStream#crossLeft.

  9. final def <*>[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, (O, O2)]

    Permalink

    Symbolic alias for ZStream#cross.

  10. final def <>[R1 <: R, E2, O1 >: O](that: ⇒ ZStream[R1, E2, O1])(implicit ev: CanFail[E]): ZStream[R1, E2, O1]

    Permalink

    Symbolic alias for ZStream#orElse.

  11. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def >>=[R1 <: R, E1 >: E, O2](f0: (O) ⇒ ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Symbolic alias for ZStream#flatMap.

  13. def >>>[R1 <: R, E1 >: E, O2 >: O, Z](sink: ZSink[R1, E1, O2, Z]): ZIO[R1, E1, Z]

    Permalink

    Symbolic alias for zio.stream.ZStream!.run[R1<:R,E1>:E,B]*.

  14. def >>>[R1 <: R, E1 >: E, O2 >: O, O3](transducer: ZTransducer[R1, E1, O2, O3]): ZStream[R1, E1, O3]

    Permalink

    Symbolic alias for ZStream#transduce.

  15. final def absolve[R1 <: R, E1, O1](implicit ev: <:<[ZStream[R, E, O], ZStream[R1, E1, Either[E1, O1]]]): ZStream[R1, E1, O1]

    Permalink

    Returns a stream that submerges the error case of an Either into the ZStream.

  16. def aggregate[R1 <: R, E1 >: E, P](sink: ZTransducer[R1, E1, O, P]): ZStream[R1, E1, P]

    Permalink

    Applies an aggregator to the stream, which converts one or more elements of type A into elements of type B.

  17. final def aggregateAsync[R1 <: R, E1 >: E, P](transducer: ZTransducer[R1, E1, O, P]): ZStream[R1, E1, P]

    Permalink

    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 transducer can be used here, but see ZTransducer.foldWeightedM and ZTransducer.foldUntilM for transducers that cover the common usecases.

  18. final def aggregateAsyncWithin[R1 <: R, E1 >: E, P](transducer: ZTransducer[R1, E1, O, P], schedule: Schedule[R1, Chunk[P], Any]): ZStream[R1, E1, P]

    Permalink

    Uses aggregateAsyncWithinEither but only returns the Right results.

    Uses aggregateAsyncWithinEither but only returns the Right results.

    R1

    environment type

    E1

    error type

    P

    type of the value produced by the given transducer and consumed by the given schedule

    transducer

    used for the aggregation

    schedule

    signalling for when to stop the aggregation

    returns

    ZStream[R1, E1, B]

  19. final def aggregateAsyncWithinEither[R1 <: R, E1 >: E, P, Q](transducer: ZTransducer[R1, E1, O, P], schedule: Schedule[R1, Chunk[P], Q]): ZStream[R1, E1, Either[Q, P]]

    Permalink

    Aggregates elements using the provided transducer until it signals completion, or the delay signalled by the schedule has passed.

    Aggregates elements using the provided transducer until it signals completion, or 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 transducer 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.

    R1

    environment type

    E1

    error type

    P

    type of the value produced by the given transducer and consumed by the given schedule

    Q

    type of the value produced by the given schedule

    transducer

    used for the aggregation

    schedule

    signalling for when to stop the aggregation

    returns

    ZStream[R1, E1, Either[Q, P]]

  20. def as[O2](o2: ⇒ O2): ZStream[R, E, O2]

    Permalink

    Maps the success values of this stream to the specified constant value.

  21. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  22. def bimap[E1, O1](f: (E) ⇒ E1, g: (O) ⇒ O1)(implicit ev: CanFail[E]): ZStream[R, E1, O1]

    Permalink

    Returns a stream whose failure and success channels have been mapped by the specified pair of functions, f and g.

  23. final def broadcast(n: Int, maximumLag: Int): ZManaged[R, Nothing, List[ZStream[Any, E, O]]]

    Permalink

    Fan out the stream, producing a list of streams that have the same elements as this stream.

    Fan out the stream, producing a list of streams that have the same elements as this stream. The driver stream will only ever advance of the maximumLag chunks before the slowest downstream stream.

  24. final def broadcastDynamic(maximumLag: Int): ZManaged[R, Nothing, UIO[ZStream[Any, E, O]]]

    Permalink

    Fan out the stream, producing a dynamic number of streams that have the same elements as this stream.

    Fan out the stream, producing a dynamic number of streams that have the same elements as this stream. The driver stream will only ever advance of the maximumLag chunks before the slowest downstream stream.

  25. final def broadcastedQueues(n: Int, maximumLag: Int): ZManaged[R, Nothing, List[Dequeue[Exit[Option[E], O]]]]

    Permalink

    Converts the stream to a managed list of queues.

    Converts the stream to a managed list of queues. Every value will be replicated to every queue with the slowest queue being allowed to buffer maximumLag chunks before the driver is backpressured. The downstream queues will be provided with chunks in the same order they are returned, so the fastest queue might have seen up to (maximumLag + 1) chunks more than the slowest queue if it has a lower index than the slowest queue.

    Queues can unsubscribe from upstream by shutting down.

  26. final def broadcastedQueuesDynamic(maximumLag: Int): ZManaged[R, Nothing, UIO[Dequeue[Exit[Option[E], O]]]]

    Permalink

    Converts the stream to a managed dynamic amount of queues.

    Converts the stream to a managed dynamic amount of queues. Every chunk will be replicated to every queue with the slowest queue being allowed to buffer maximumLag chunks before the driver is backpressured. The downstream queues will be provided with chunks in the same order they are returned, so the fastest queue might have seen up to (maximumLag + 1) chunks more than the slowest queue if it has a lower index than the slowest queue.

    Queues can unsubscribe from upstream by shutting down.

  27. final def buffer(capacity: Int): ZStream[R, E, O]

    Permalink

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity chunks in a queue.

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity chunks in a queue.

    Note

    Prefer capacities that are powers of 2 for better performance.

  28. final def bufferDropping(capacity: Int): ZStream[R, E, O]

    Permalink

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity elements in a dropping queue.

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity elements in a dropping queue.

    Note

    Prefer capacities that are powers of 2 for better performance.

  29. final def bufferSliding(capacity: Int): ZStream[R, E, O]

    Permalink

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity elements in a sliding queue.

    Allows a faster producer to progress independently of a slower consumer by buffering up to capacity elements in a sliding queue.

    Note

    Prefer capacities that are powers of 2 for better performance.

  30. final def bufferUnbounded: ZStream[R, E, O]

    Permalink

    Allows a faster producer to progress independently of a slower consumer by buffering elements into an unbounded queue.

  31. final def catchAll[R1 <: R, E2, O1 >: O](f: (E) ⇒ ZStream[R1, E2, O1])(implicit ev: CanFail[E]): ZStream[R1, E2, O1]

    Permalink

    Switches over to the stream produced by the provided function in case this one fails with a typed error.

  32. final def catchAllCause[R1 <: R, E2, O1 >: O](f: (Cause[E]) ⇒ ZStream[R1, E2, O1]): ZStream[R1, E2, O1]

    Permalink

    Switches over to the stream produced by the provided function in case this one fails.

    Switches over to the stream produced by the provided function in case this one fails. Allows recovery from all causes of failure, including interruption if the stream is uninterruptible.

  33. final def catchSome[R1 <: R, E1 >: E, O1 >: O](pf: PartialFunction[E, ZStream[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Switches over to the stream produced by the provided function in case this one fails with some typed error.

  34. final def catchSomeCause[R1 <: R, E1 >: E, O1 >: O](pf: PartialFunction[Cause[E], ZStream[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Switches over to the stream produced by the provided function in case this one fails with some errors.

    Switches over to the stream produced by the provided function in case this one fails with some errors. Allows recovery from all causes of failure, including interruption if the stream is uninterruptible.

  35. def chunkN(n: Int): ZStream[R, E, O]

    Permalink

    Re-chunks the elements of the stream into chunks of n elements each.

    Re-chunks the elements of the stream into chunks of n elements each. The last chunk might contain less than n elements

  36. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def collect[O1](pf: PartialFunction[O, O1]): ZStream[R, E, O1]

    Permalink

    Performs a filter and map in a single step.

  38. final def collectM[R1 <: R, E1 >: E, O1](pf: PartialFunction[O, ZIO[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Performs an effectful filter and map in a single step.

  39. final def collectSome[O1](implicit ev: <:<[O, Option[O1]]): ZStream[R, E, O1]

    Permalink

    Filters any 'None'.

  40. def collectWhile[O2](p: PartialFunction[O, O2]): ZStream[R, E, O2]

    Permalink

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

  41. final def collectWhileM[R1 <: R, E1 >: E, O2](pf: PartialFunction[O, ZIO[R1, E1, O2]]): ZStream[R1, E1, O2]

    Permalink

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

  42. final def collectWhileSome[O1](implicit ev: <:<[O, Option[O1]]): ZStream[R, E, O1]

    Permalink

    Terminates the stream when encountering the first None.

  43. def collectWhileSuccess[E1 >: E, O1](implicit ev: <:<[O, Exit[Option[E1], O1]]): ZStream[R, E1, O1]

    Permalink

    Unwraps Exit values that also signify end-of-stream by failing with None.

    Unwraps Exit values that also signify end-of-stream by failing with None.

    For Exit[E, O] values that do not signal end-of-stream, prefer:

    stream.mapM(ZIO.done(_))
  44. final def combine[R1 <: R, E1 >: E, S, O2, O3](that: ZStream[R1, E1, O2])(s: S)(f: (S, ZIO[R, Option[E], O], ZIO[R1, Option[E1], O2]) ⇒ ZIO[R1, Nothing, Exit[Option[E1], (O3, S)]]): ZStream[R1, E1, O3]

    Permalink

    Combines the elements from this stream and the specified stream by repeatedly applying the function f to extract an element using both sides and conceptually "offer" it to the destination stream.

    Combines the elements from this stream and the specified stream by repeatedly applying the function f to extract an element using both sides and conceptually "offer" it to the destination stream. f can maintain some internal state to control the combining process, with the initial state being specified by s.

    Where possible, prefer ZStream#combineChunks for a more efficient implementation.

  45. final def combineChunks[R1 <: R, E1 >: E, S, O2, O3](that: ZStream[R1, E1, O2])(s: S)(f: (S, ZIO[R, Option[E], Chunk[O]], ZIO[R1, Option[E1], Chunk[O2]]) ⇒ ZIO[R1, Nothing, Exit[Option[E1], (Chunk[O3], S)]]): ZStream[R1, E1, O3]

    Permalink

    Combines the chunks from this stream and the specified stream by repeatedly applying the function f to extract a chunk using both sides and conceptually "offer" it to the destination stream.

    Combines the chunks from this stream and the specified stream by repeatedly applying the function f to extract a chunk using both sides and conceptually "offer" it to the destination stream. f can maintain some internal state to control the combining process, with the initial state being specified by s.

  46. def concat[R1 <: R, E1 >: E, O1 >: O](that: ⇒ ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Concatenates the specified stream with this stream, resulting in a stream that emits the elements from this stream and then the elements from the specified stream.

  47. final def cross[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, (O, O2)]

    Permalink

    Composes this stream with the specified stream to create a cartesian product of elements.

    Composes this stream with the specified stream to create a cartesian product of elements. The that stream would be run multiple times, for every element in the this stream.

    See also ZStream#zip and ZStream#<&> for the more common point-wise variant.

  48. final def crossLeft[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O]

    Permalink

    Composes this stream with the specified stream to create a cartesian product of elements, but keeps only elements from this stream.

    Composes this stream with the specified stream to create a cartesian product of elements, but keeps only elements from this stream. The that stream would be run multiple times, for every element in the this stream.

    See also ZStream#zip and ZStream#<&> for the more common point-wise variant.

  49. final def crossRight[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Composes this stream with the specified stream to create a cartesian product of elements, but keeps only elements from the other stream.

    Composes this stream with the specified stream to create a cartesian product of elements, but keeps only elements from the other stream. The that stream would be run multiple times, for every element in the this stream.

    See also ZStream#zip and ZStream#<&> for the more common point-wise variant.

  50. final def crossWith[R1 <: R, E1 >: E, O2, C](that: ZStream[R1, E1, O2])(f: (O, O2) ⇒ C): ZStream[R1, E1, C]

    Permalink

    Composes this stream with the specified stream to create a cartesian product of elements with a specified function.

    Composes this stream with the specified stream to create a cartesian product of elements with a specified function. The that stream would be run multiple times, for every element in the this stream.

    See also ZStream#zip and ZStream#<&> for the more common point-wise variant.

  51. final def debounce[E1 >: E, O2 >: O](d: Duration): ZStream[R with Clock, E1, O2]

    Permalink
  52. final def distributedWith[E1 >: E](n: Int, maximumLag: Int, decide: (O) ⇒ UIO[(Int) ⇒ Boolean]): ZManaged[R, Nothing, List[Dequeue[Exit[Option[E1], O]]]]

    Permalink

    More powerful version of ZStream#broadcast.

    More powerful version of ZStream#broadcast. Allows to provide a function that determines what queues should receive which elements. The decide function will receive the indices of the queues in the resulting list.

  53. final def distributedWithDynamic(maximumLag: Int, decide: (O) ⇒ UIO[(UniqueKey) ⇒ Boolean], done: (Exit[Option[E], Nothing]) ⇒ UIO[Any] = (_: Any) => UIO.unit): ZManaged[R, Nothing, UIO[(UniqueKey, Dequeue[Exit[Option[E], O]])]]

    Permalink

    More powerful version of ZStream#distributedWith.

    More powerful version of ZStream#distributedWith. This returns a function that will produce new queues and corresponding indices. You can also provide a function that will be executed after the final events are enqueued in all queues. Shutdown of the queues is handled by the driver. Downstream users can also shutdown queues manually. In this case the driver will continue but no longer backpressure on them.

  54. final def drain: ZStream[R, E, Nothing]

    Permalink

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

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

    (Stream(1, 2, 3).tap(i => ZIO(println(i))) ++
      Stream.fromEffect(ZIO(println("Done!"))).drain ++
      Stream(4, 5, 6).tap(i => ZIO(println(i)))).run(Sink.drain)
  55. final def drainFork[R1 <: R, E1 >: E](other: ZStream[R1, E1, Any]): ZStream[R1, E1, O]

    Permalink

    Drains the provided stream in the background for as long as this stream is running.

    Drains the provided stream in the background for as long as this stream is running. If this stream ends before other, other will be interrupted. If other fails, this stream will fail with that error.

  56. def drop(n: Long): ZStream[R, E, O]

    Permalink

    Drops the specified number of elements from this stream.

  57. final def dropUntil(pred: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

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

  58. def dropWhile(pred: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

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

  59. final def either(implicit ev: CanFail[E]): ZStream[R, Nothing, Either[E, O]]

    Permalink

    Returns a stream whose failures and successes have been lifted into an Either.

    Returns a stream whose failures and successes have been lifted into an Either. The resulting stream cannot fail, because the failures have been exposed as part of the Either success case.

    Note

    the stream will end as soon as the first error occurs.

  60. final def ensuring[R1 <: R](fin: ZIO[R1, Nothing, Any]): ZStream[R1, E, O]

    Permalink

    Executes the provided finalizer after this stream's finalizers run.

  61. final def ensuringFirst[R1 <: R](fin: ZIO[R1, Nothing, Any]): ZStream[R1, E, O]

    Permalink

    Executes the provided finalizer before this stream's finalizers run.

  62. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  63. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  64. def filter(f: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

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

  65. def filterM[R1 <: R, E1 >: E](f: (O) ⇒ ZIO[R1, E1, Boolean]): ZStream[R1, E1, O]

    Permalink

    Effectfully filters the elements emitted by this stream.

  66. final def filterNot(pred: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

    Filters this stream by the specified predicate, removing all elements for which the predicate evaluates to true.

  67. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  68. final def fixed[R1 <: R](duration: Duration): ZStream[R1 with Clock, E, O]

    Permalink

    Emits elements of this stream with a fixed delay in between, regardless of how long it takes to produce a value.

  69. def flatMap[R1 <: R, E1 >: E, O2](f0: (O) ⇒ ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Returns a stream made of the concatenation in strict order of all the streams produced by passing each element of this stream to f0

  70. final def flatMapPar[R1 <: R, E1 >: E, O2](n: Int, outputBuffer: Int = 16)(f: (O) ⇒ ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Maps each element of this stream to another stream and returns the non-deterministic merge of those streams, executing up to n inner streams concurrently.

    Maps each element of this stream to another stream and returns the non-deterministic merge of those streams, executing up to n inner streams concurrently. Up to outputBuffer elements of the produced streams may be buffered in memory by this operator.

  71. final def flatMapParSwitch[R1 <: R, E1 >: E, O2](n: Int, bufferSize: Int = 16)(f: (O) ⇒ ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Maps each element of this stream to another stream and returns the non-deterministic merge of those streams, executing up to n inner streams concurrently.

    Maps each element of this stream to another stream and returns the non-deterministic merge of those streams, executing up to n inner streams concurrently. When a new stream is created from an element of the source stream, the oldest executing stream is cancelled. Up to bufferSize elements of the produced streams may be buffered in memory by this operator.

  72. def flatten[R1 <: R, E1 >: E, O1](implicit ev: <:<[O, ZStream[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Flattens this stream-of-streams into a stream made of the concatenation in strict order of all the streams.

  73. def flattenChunks[O1](implicit ev: <:<[O, Chunk[O1]]): ZStream[R, E, O1]

    Permalink

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

  74. def flattenPar[R1 <: R, E1 >: E, O1](n: Int, outputBuffer: Int = 16)(implicit ev: <:<[O, ZStream[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Flattens a stream of streams into a stream by executing a non-deterministic concurrent merge.

    Flattens a stream of streams into a stream by executing a non-deterministic concurrent merge. Up to n streams may be consumed in parallel and up to outputBuffer elements may be buffered by this operator.

  75. def flattenParUnbounded[R1 <: R, E1 >: E, O1](outputBuffer: Int = 16)(implicit ev: <:<[O, ZStream[R1, E1, O1]]): ZStream[R1, E1, O1]

    Permalink

    Like flattenPar, but executes all streams concurrently.

  76. final def fold[O1 >: O, S](s: S)(f: (S, O1) ⇒ S): ZIO[R, E, S]

    Permalink

    Executes a pure fold over the stream of values - reduces all elements in the stream to a value of type S.

  77. final def foldM[R1 <: R, E1 >: E, O1 >: O, S](s: S)(f: (S, O1) ⇒ ZIO[R1, E1, S]): ZIO[R1, E1, S]

    Permalink

    Executes an effectful fold over the stream of values.

  78. final def foldManaged[O1 >: O, S](s: S)(f: (S, O1) ⇒ S): ZManaged[R, E, S]

    Permalink

    Executes a pure fold over the stream of values.

    Executes a pure fold over the stream of values. Returns a Managed value that represents the scope of the stream.

  79. final def foldManagedM[R1 <: R, E1 >: E, O1 >: O, S](s: S)(f: (S, O1) ⇒ ZIO[R1, E1, S]): ZManaged[R1, E1, S]

    Permalink

    Executes an effectful fold over the stream of values.

    Executes an effectful fold over the stream of values. Returns a Managed value that represents the scope of the stream.

  80. final def foldWhile[O1 >: O, S](s: S)(cont: (S) ⇒ Boolean)(f: (S, O1) ⇒ S): ZIO[R, E, S]

    Permalink

    Reduces the elements in the stream to a value of type S.

    Reduces the elements in the stream to a value of type S. Stops the fold early when the condition is not fulfilled. Example:

    Stream(1).forever.foldWhile(0)(_ <= 4)(_ + _) // UIO[Int] == 5
  81. final def foldWhileM[R1 <: R, E1 >: E, O1 >: O, S](s: S)(cont: (S) ⇒ Boolean)(f: (S, O1) ⇒ ZIO[R1, E1, S]): ZIO[R1, E1, S]

    Permalink

    Executes an effectful fold over the stream of values.

    Executes an effectful fold over the stream of values. Stops the fold early when the condition is not fulfilled. Example:

    Stream(1)
      .forever                                // an infinite Stream of 1's
      .fold(0)(_ <= 4)((s, a) => UIO(s + a))  // UIO[Int] == 5
    cont

    function which defines the early termination condition

  82. def foldWhileManaged[O1 >: O, S](s: S)(cont: (S) ⇒ Boolean)(f: (S, O1) ⇒ S): ZManaged[R, E, S]

    Permalink

    Executes a pure fold over the stream of values.

    Executes a pure fold over the stream of values. Returns a Managed value that represents the scope of the stream. Stops the fold early when the condition is not fulfilled.

  83. final def foldWhileManagedM[R1 <: R, E1 >: E, A1 >: O, S](s: S)(cont: (S) ⇒ Boolean)(f: (S, A1) ⇒ ZIO[R1, E1, S]): ZManaged[R1, E1, S]

    Permalink

    Executes an effectful fold over the stream of values.

    Executes an effectful fold over the stream of values. Returns a Managed value that represents the scope of the stream. Stops the fold early when the condition is not fulfilled. Example:

    Stream(1)
      .forever                                // an infinite Stream of 1's
      .fold(0)(_ <= 4)((s, a) => UIO(s + a))  // Managed[Nothing, Int]
      .use(ZIO.succeed)                       // UIO[Int] == 5
    cont

    function which defines the early termination condition

  84. final def foreach[R1 <: R, E1 >: E](f: (O) ⇒ ZIO[R1, E1, Any]): ZIO[R1, E1, Unit]

    Permalink

    Consumes all elements of the stream, passing them to the specified callback.

  85. final def foreachChunk[R1 <: R, E1 >: E](f: (Chunk[O]) ⇒ ZIO[R1, E1, Any]): ZIO[R1, E1, Unit]

    Permalink

    Consumes all elements of the stream, passing them to the specified callback.

  86. final def foreachChunkManaged[R1 <: R, E1 >: E](f: (Chunk[O]) ⇒ ZIO[R1, E1, Any]): ZManaged[R1, E1, Unit]

    Permalink

    Like ZStream#foreachChunk, but returns a ZManaged so the finalization order can be controlled.

  87. final def foreachChunkWhile[R1 <: R, E1 >: E](f: (Chunk[O]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Unit]

    Permalink

    Consumes chunks of the stream, passing them to the specified callback, and terminating consumption when the callback returns false.

  88. final def foreachChunkWhileManaged[R1 <: R, E1 >: E](f: (Chunk[O]) ⇒ ZIO[R1, E1, Boolean]): ZManaged[R1, E1, Unit]

    Permalink

    Like ZStream#foreachChunkWhile, but returns a ZManaged so the finalization order can be controlled.

  89. final def foreachManaged[R1 <: R, E1 >: E](f: (O) ⇒ ZIO[R1, E1, Any]): ZManaged[R1, E1, Unit]

    Permalink

    Like ZStream#foreach, but returns a ZManaged so the finalization order can be controlled.

  90. final def foreachWhile[R1 <: R, E1 >: E](f: (O) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Unit]

    Permalink

    Consumes elements of the stream, passing them to the specified callback, and terminating consumption when the callback returns false.

  91. final def foreachWhileManaged[R1 <: R, E1 >: E](f: (O) ⇒ ZIO[R1, E1, Boolean]): ZManaged[R1, E1, Unit]

    Permalink

    Like ZStream#foreachWhile, but returns a ZManaged so the finalization order can be controlled.

  92. def forever: ZStream[R, E, O]

    Permalink

    Repeats this stream forever.

  93. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  94. final def groupBy[R1 <: R, E1 >: E, K, V](f: (O) ⇒ ZIO[R1, E1, (K, V)], buffer: Int = 16): GroupBy[R1, E1, K, V]

    Permalink

    More powerful version of ZStream.groupByKey

  95. final def groupByKey[K](f: (O) ⇒ K, buffer: Int = 16): GroupBy[R, E, K, O]

    Permalink

    Partition a stream using a function and process each stream individually.

    Partition a stream using a function and process each stream individually. This returns a data structure that can be used to further filter down which groups shall be processed.

    After calling apply on the GroupBy object, the remaining groups will be processed in parallel and the resulting streams merged in a nondeterministic fashion.

    Up to buffer elements may be buffered in any group stream before the producer is backpressured. Take care to consume from all streams in order to prevent deadlocks.

    Example: Collect the first 2 words for every starting letter from a stream of words.

    ZStream.fromIterable(List("hello", "world", "hi", "holla"))
     .groupByKey(_.head) { case (k, s) => s.take(2).map((k, _)) }
     .runCollect
     .map(_ == List(('h', "hello"), ('h', "hi"), ('w', "world"))
  96. def grouped(chunkSize: Long): ZStream[R, E, List[O]]

    Permalink

    Partitions the stream with specified chunkSize

    Partitions the stream with specified chunkSize

    chunkSize

    size of the chunk

  97. def groupedWithin(chunkSize: Long, within: Duration): ZStream[R with Clock, E, List[O]]

    Permalink

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

  98. final def haltAfter(duration: Duration): ZStream[R with Clock, E, O]

    Permalink

    Specialized version of haltWhen which halts the evaluation of this stream after the given duration.

    Specialized version of haltWhen which halts the evaluation of this stream after the given duration.

    An element in the process of being pulled will not be interrupted when the given duration completes. See interruptAfter for this behavior.

  99. final def haltWhen[E1 >: E](p: Promise[E1, _]): ZStream[R, E1, O]

    Permalink

    Halts the evaluation of this stream when the provided promise resolves.

    Halts the evaluation of this stream when the provided promise resolves.

    If the promise completes with a failure, the stream will emit that failure.

  100. final def haltWhen[R1 <: R, E1 >: E](io: ZIO[R1, E1, Any]): ZStream[R1, E1, O]

    Permalink

    Halts the evaluation of this stream when the provided IO completes.

    Halts the evaluation of this stream when the provided IO completes. The given IO will be forked as part of the returned stream, and its success will be discarded.

    An element in the process of being pulled will not be interrupted when the IO completes. See interruptWhen for this behavior.

    If the IO completes with a failure, the stream will emit that failure.

  101. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  102. final def interleave[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Interleaves this stream and the specified stream deterministically by alternating pulling values from this stream and the specified stream.

    Interleaves this stream and the specified stream deterministically by alternating pulling values from this stream and the specified stream. When one stream is exhausted all remaining values in the other stream will be pulled.

  103. final def interleaveWith[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1])(b: ZStream[R1, E1, Boolean]): ZStream[R1, E1, O1]

    Permalink

    Combines this stream and the specified stream deterministically using the stream of boolean values b to control which stream to pull from next.

    Combines this stream and the specified stream deterministically using the stream of boolean values b to control which stream to pull from next. true indicates to pull from this stream and false indicates to pull from the specified stream. Only consumes as many elements as requested by b. If either this stream or the specified stream are exhausted further requests for values from that stream will be ignored.

  104. final def interruptAfter(duration: Duration): ZStream[R with Clock, E, O]

    Permalink

    Specialized version of interruptWhen which interrupts the evaluation of this stream after the given duration.

  105. final def interruptWhen[E1 >: E](p: Promise[E1, _]): ZStream[R, E1, O]

    Permalink

    Interrupts the evaluation of this stream when the provided promise resolves.

    Interrupts the evaluation of this stream when the provided promise resolves. This combinator will also interrupt any in-progress element being pulled from upstream.

    If the promise completes with a failure, the stream will emit that failure.

  106. final def interruptWhen[R1 <: R, E1 >: E](io: ZIO[R1, E1, Any]): ZStream[R1, E1, O]

    Permalink

    Interrupts the evaluation of this stream when the provided IO completes.

    Interrupts the evaluation of this stream when the provided IO completes. The given IO will be forked as part of this stream, and its success will be discarded. This combinator will also interrupt any in-progress element being pulled from upstream.

    If the IO completes with a failure before the stream completes, the returned stream will emit that failure.

  107. final def intersperse[O1 >: O](start: O1, middle: O1, end: O1): ZStream[R, E, O1]

    Permalink

    Intersperse and also add a prefix and a suffix

  108. final def intersperse[O1 >: O](middle: O1): ZStream[R, E, O1]

    Permalink

    Intersperse stream with provided element similar to List.mkString.

    Intersperse stream with provided element similar to List.mkString.

  109. final def into[R1 <: R, E1 >: E, O1 >: O](queue: ZQueue[R1, Nothing, Nothing, Any, Exit[Option[E1], Chunk[O1]], Any]): ZIO[R1, E1, Unit]

    Permalink

    Enqueues elements of this stream into a queue.

    Enqueues elements of this stream into a queue. Stream failure and ending will also be signalled.

  110. final def intoManaged[R1 <: R, E1 >: E, O1 >: O](queue: ZQueue[R1, Nothing, Nothing, Any, Exit[Option[E1], Chunk[O1]], Any]): ZManaged[R1, E1, Unit]

    Permalink

    Like ZStream#into, but provides the result as a ZManaged to allow for scope composition.

  111. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  112. def map[O2](f: (O) ⇒ O2): ZStream[R, E, O2]

    Permalink

    Transforms the elements of this stream using the supplied function.

  113. def mapAccum[S, O1](s: S)(f: (S, O) ⇒ (S, O1)): ZStream[R, E, O1]

    Permalink

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

  114. final def mapAccumM[R1 <: R, E1 >: E, S, O1](s: S)(f: (S, O) ⇒ ZIO[R1, E1, (S, O1)]): ZStream[R1, E1, O1]

    Permalink

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

  115. def mapChunks[O2](f: (Chunk[O]) ⇒ Chunk[O2]): ZStream[R, E, O2]

    Permalink

    Transforms the chunks emitted by this stream.

  116. def mapChunksM[R1 <: R, E1 >: E, O2](f: (Chunk[O]) ⇒ ZIO[R1, E1, Chunk[O2]]): ZStream[R1, E1, O2]

    Permalink

    Effectfully transforms the chunks emitted by this stream.

  117. def mapConcat[O2](f: (O) ⇒ Iterable[O2]): ZStream[R, E, O2]

    Permalink

    Maps each element to an iterable, and flattens the iterables into the output of this stream.

  118. def mapConcatChunk[O2](f: (O) ⇒ Chunk[O2]): ZStream[R, E, O2]

    Permalink

    Maps each element to a chunk, and flattens the chunks into the output of this stream.

  119. final def mapConcatChunkM[R1 <: R, E1 >: E, O2](f: (O) ⇒ ZIO[R1, E1, Chunk[O2]]): ZStream[R1, E1, O2]

    Permalink

    Effectfully maps each element to a chunk, and flattens the chunks into the output of this stream.

  120. final def mapConcatM[R1 <: R, E1 >: E, O2](f: (O) ⇒ ZIO[R1, E1, Iterable[O2]]): ZStream[R1, E1, O2]

    Permalink

    Effectfully maps each element to an iterable, and flattens the iterables into the output of this stream.

  121. def mapError[E2](f: (E) ⇒ E2): ZStream[R, E2, O]

    Permalink

    Transforms the errors emitted by this stream using f.

  122. def mapErrorCause[E2](f: (Cause[E]) ⇒ Cause[E2]): ZStream[R, E2, O]

    Permalink

    Transforms the full causes of failures emitted by this stream.

  123. def mapM[R1 <: R, E1 >: E, O2](f: (O) ⇒ ZIO[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Maps over elements of the stream with the specified effectful function.

  124. final def mapMPar[R1 <: R, E1 >: E, O2](n: Int)(f: (O) ⇒ ZIO[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    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.

  125. final def mapMParUnordered[R1 <: R, E1 >: E, O2](n: Int)(f: (O) ⇒ ZIO[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    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.

  126. final def mapMPartitioned[R1 <: R, E1 >: E, O2, K](keyBy: (O) ⇒ K, buffer: Int = 16)(f: (O) ⇒ ZIO[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Maps over elements of the stream with the specified effectful function, partitioned by p executing invocations of f concurrently.

    Maps over elements of the stream with the specified effectful function, partitioned by p executing invocations of f concurrently. The number of concurrent invocations of f is determined by the number of different outputs of type K. Up to buffer elements may be buffered per partition. Transformed elements may be reordered but the order within a partition is maintained.

  127. final def merge[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1], strategy: TerminationStrategy = TerminationStrategy.Both): ZStream[R1, E1, O1]

    Permalink

    Merges this stream and the specified stream together.

    Merges this stream and the specified stream together.

    New produced stream will terminate when both specified stream terminate if no termination strategy is specified.

  128. final def mergeEither[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, Either[O, O2]]

    Permalink

    Merges this stream and the specified stream together to produce a stream of eithers.

  129. final def mergeTerminateEither[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Merges this stream and the specified stream together.

    Merges this stream and the specified stream together. New produced stream will terminate when either stream terminates.

  130. final def mergeTerminateLeft[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Merges this stream and the specified stream together.

    Merges this stream and the specified stream together. New produced stream will terminate when this stream terminates.

  131. final def mergeTerminateRight[R1 <: R, E1 >: E, O1 >: O](that: ZStream[R1, E1, O1]): ZStream[R1, E1, O1]

    Permalink

    Merges this stream and the specified stream together.

    Merges this stream and the specified stream together. New produced stream will terminate when the specefied stream terminates.

  132. final def mergeWith[R1 <: R, E1 >: E, O2, O3](that: ZStream[R1, E1, O2], strategy: TerminationStrategy = TerminationStrategy.Both)(l: (O) ⇒ O3, r: (O2) ⇒ O3): ZStream[R1, E1, O3]

    Permalink

    Merges this stream and the specified stream together to a common element type with the specified mapping functions.

    Merges this stream and the specified stream together to a common element type with the specified mapping functions.

    New produced stream will terminate when both specified stream terminate if no termination strategy is specified.

  133. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  134. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  135. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  136. final def orElse[R1 <: R, E2, O1 >: O](that: ⇒ ZStream[R1, E2, O1])(implicit ev: CanFail[E]): ZStream[R1, E2, O1]

    Permalink

    Switches to the provided stream in case this one fails with a typed error.

    Switches to the provided stream in case this one fails with a typed error.

    See also ZStream#catchAll.

  137. final def orElseEither[R1 <: R, E2, O2](that: ⇒ ZStream[R1, E2, O2])(implicit ev: CanFail[E]): ZStream[R1, E2, Either[O, O2]]

    Permalink

    Switches to the provided stream in case this one fails with a typed error.

    Switches to the provided stream in case this one fails with a typed error.

    See also ZStream#catchAll.

  138. final def orElseFail[E1](e1: ⇒ E1)(implicit ev: CanFail[E]): ZStream[R, E1, O]

    Permalink

    Fails with given error in case this one fails with a typed error.

    Fails with given error in case this one fails with a typed error.

    See also ZStream#catchAll.

  139. final def orElseOptional[R1 <: R, E1, O1 >: O](that: ⇒ ZStream[R1, Option[E1], O1])(implicit ev: <:<[E, Option[E1]]): ZStream[R1, Option[E1], O1]

    Permalink

    Switches to the provided stream in case this one fails with the None value.

    Switches to the provided stream in case this one fails with the None value.

    See also ZStream#catchAll.

  140. final def orElseSucceed[O1 >: O](o1: ⇒ O1)(implicit ev: CanFail[E]): ZStream[R, Nothing, O1]

    Permalink

    Succeeds with the specified value if this one fails with a typed error.

  141. def partition(p: (O) ⇒ Boolean, buffer: Int = 16): ZManaged[R, E, (ZStream[Any, E, O], ZStream[Any, E, O])]

    Permalink

    Partition a stream using a predicate.

    Partition a stream using a predicate. The first stream will contain all element evaluated to true and the second one will contain all element evaluated to false. The faster stream may advance by up to buffer elements further than the slower one.

  142. final def partitionEither[R1 <: R, E1 >: E, O2, O3](p: (O) ⇒ ZIO[R1, E1, Either[O2, O3]], buffer: Int = 16): ZManaged[R1, E1, (ZStream[Any, E1, O2], ZStream[Any, E1, O3])]

    Permalink

    Split a stream by a predicate.

    Split a stream by a predicate. The faster stream may advance by up to buffer elements further than the slower one.

  143. def peel[R1 <: R, E1 >: E, Z](sink: ZSink[R1, E1, O, Z]): ZManaged[R1, E1, (Z, ZStream[R1, E1, O])]

    Permalink

    Peels off enough material from the stream to construct a Z using the provided ZSink and then returns both the Z and the rest of the ZStream in a managed resource.

    Peels off enough material from the stream to construct a Z using the provided ZSink and then returns both the Z and the rest of the ZStream in a managed resource. Like all ZManaged values, the provided stream is valid only within the scope of ZManaged.

  144. val process: ZManaged[R, Nothing, ZIO[R, Option[E], Chunk[O]]]

    Permalink
  145. final def provide(r: R)(implicit ev: NeedsEnv[R]): ZStream[Any, E, O]

    Permalink

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

  146. def provideCustomLayer[E1 >: E, R1 <: Has[_]](layer: ZLayer[zio.ZEnv, E1, R1])(implicit ev: <:<[zio.ZEnv with R1, R], tagged: zio.Tag[R1]): ZStream[zio.ZEnv, E1, O]

    Permalink

    Provides the part of the environment that is not part of the ZEnv, leaving a stream that only depends on the ZEnv.

    Provides the part of the environment that is not part of the ZEnv, leaving a stream that only depends on the ZEnv.

    val loggingLayer: ZLayer[Any, Nothing, Logging] = ???
    
    val stream: ZStream[ZEnv with Logging, Nothing, Unit] = ???
    
    val stream2 = stream.provideCustomLayer(loggingLayer)
  147. final def provideLayer[E1 >: E, R0, R1](layer: ZLayer[R0, E1, R1])(implicit ev1: <:<[R1, R], ev2: NeedsEnv[R]): ZStream[R0, E1, O]

    Permalink

    Provides a layer to the stream, which translates it to another level.

  148. final def provideSome[R0](env: (R0) ⇒ R)(implicit ev: NeedsEnv[R]): ZStream[R0, E, O]

    Permalink

    Provides some of the environment required to run this effect, leaving the remainder R0.

  149. final def provideSomeLayer[R0 <: Has[_]]: ProvideSomeLayer[R0, R, E, O]

    Permalink

    Splits the environment into two parts, providing one part using the specified layer and leaving the remainder R0.

    Splits the environment into two parts, providing one part using the specified layer and leaving the remainder R0.

    val clockLayer: ZLayer[Any, Nothing, Clock] = ???
    
    val stream: ZStream[Clock with Random, Nothing, Unit] = ???
    
    val stream2 = stream.provideSomeLayer[Random](clockLayer)
  150. final def refineOrDie[E1](pf: PartialFunction[E, E1])(implicit ev1: <:<[E, Throwable], ev2: CanFail[E]): ZStream[R, E1, O]

    Permalink

    Keeps some of the errors, and terminates the fiber with the rest

  151. final def refineOrDieWith[E1](pf: PartialFunction[E, E1])(f: (E) ⇒ Throwable)(implicit ev: CanFail[E]): ZStream[R, E1, O]

    Permalink

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

  152. final def repeat[R1 <: R, B](schedule: Schedule[R1, Any, B]): ZStream[R1, E, O]

    Permalink

    Repeats the entire stream using the specified schedule.

    Repeats the entire stream using the specified schedule. The stream will execute normally, and then repeat again according to the provided schedule.

  153. final def repeatEither[R1 <: R, B](schedule: Schedule[R1, Any, B]): ZStream[R1, E, Either[B, O]]

    Permalink

    Repeats the entire stream using the specified schedule.

    Repeats the entire stream using the specified schedule. The stream will execute normally, and then repeat again according to the provided schedule. The schedule output will be emitted at the end of each repetition.

  154. final def repeatWith[R1 <: R, B, C](schedule: Schedule[R1, Any, B])(f: (O) ⇒ C, g: (B) ⇒ C): ZStream[R1, E, C]

    Permalink

    Repeats the entire stream using the specified schedule.

    Repeats the entire stream using the specified schedule. The stream will execute normally, and then repeat again according to the provided schedule. The schedule output will be emitted at the end of each repetition and can be unified with the stream elements using the provided functions.

  155. final def right[O1, O2](implicit ev: <:<[O, Either[O1, O2]]): ZStream[R, Option[E], O2]

    Permalink

    Fails with the error None if value is Left.

  156. final def rightOrFail[O1, O2, E1 >: E](e: ⇒ E1)(implicit ev: <:<[O, Either[O1, O2]]): ZStream[R, E1, O2]

    Permalink

    Fails with fiven error 'e' if value is Left.

  157. def run[R1 <: R, E1 >: E, B](sink: ZSink[R1, E1, O, B]): ZIO[R1, E1, B]

    Permalink

    Runs the sink on the stream to produce either the sink's result or an error.

  158. def runCollect: ZIO[R, E, List[O]]

    Permalink

    Runs the stream and collects all of its elements to a list.

  159. final def runCount: ZIO[R, E, Long]

    Permalink

    Runs the stream and emits the number of elements processed

    Runs the stream and emits the number of elements processed

    Equivalent to run(ZSink.count)

  160. def runDrain: ZIO[R, E, Unit]

    Permalink

    Runs the stream only for its effects.

    Runs the stream only for its effects. The emitted elements are discarded.

  161. def runHead: ZIO[R, E, Option[O]]

    Permalink

    Runs the stream to completion and yields the first value emitted by it, discarding the rest of the elements.

  162. def runLast: ZIO[R, E, Option[O]]

    Permalink

    Runs the stream to completion and yields the last value emitted by it, discarding the rest of the elements.

  163. final def runSum[O1 >: O](implicit ev: Numeric[O1]): ZIO[R, E, O1]

    Permalink

    Runs the stream to a sink which sums elements, provided they are Numeric.

    Runs the stream to a sink which sums elements, provided they are Numeric.

    Equivalent to run(Sink.sum[A])

  164. final def schedule[R1 <: R](schedule: Schedule[R1, O, Any]): ZStream[R1, E, O]

    Permalink

    Schedules the output of the stream using the provided schedule.

  165. final def scheduleEither[R1 <: R, E1 >: E, B](schedule: Schedule[R1, O, B]): ZStream[R1, E1, Either[B, O]]

    Permalink

    Schedules the output of the stream using the provided schedule and emits its output at the end (if schedule is finite).

  166. final def scheduleElements[R1 <: R](schedule: Schedule[R1, O, Any]): ZStream[R1, E, O]

    Permalink

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed.

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed. Repeats are done in addition to the first execution, so that scheduleElements(Schedule.once) means "emit element and if not short circuited, repeat element once".

  167. final def scheduleElementsEither[R1 <: R, E1 >: E, B](schedule: Schedule[R1, O, B]): ZStream[R1, E1, Either[B, O]]

    Permalink

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed.

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed. Repeats are done in addition to the first execution, so that scheduleElements(Schedule.once) means "emit element and if not short circuited, repeat element once".

  168. final def scheduleElementsWith[R1 <: R, E1 >: E, B, C](schedule: Schedule[R1, O, B])(f: (O) ⇒ C, g: (B) ⇒ C): ZStream[R1, E1, C]

    Permalink

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed.

    Repeats each element of the stream using the provided schedule, additionally emitting the schedule's output each time a schedule is completed. Repeats are done in addition to the first execution, so that scheduleElements(Schedule.once) means "emit element and if not short circuited, repeat element once". Uses the provided functions to align the stream and schedule outputs on a common type.

  169. final def scheduleWith[R1 <: R, E1 >: E, B, C](schedule: Schedule[R1, O, B])(f: (O) ⇒ C, g: (B) ⇒ C): ZStream[R1, E1, C]

    Permalink

    Schedules the output of the stream using the provided schedule and emits its output at the end (if schedule is finite).

    Schedules the output of the stream using the provided schedule and emits its output at the end (if schedule is finite). Uses the provided function to align the stream and schedule outputs on the same type.

  170. final def some[O2](implicit ev: <:<[O, Option[O2]]): ZStream[R, Option[E], O2]

    Permalink

    Converts an option on values into an option on errors.

  171. final def someOrElse[O2](default: ⇒ O2)(implicit ev: <:<[O, Option[O2]]): ZStream[R, E, O2]

    Permalink

    Extracts the optional value, or returns the given 'default'.

  172. final def someOrFail[O2, E1 >: E](e: ⇒ E1)(implicit ev: <:<[O, Option[O2]]): ZStream[R, E1, O2]

    Permalink

    Extracts the optional value, or fails with the given error 'e'.

  173. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  174. def take(n: Long): ZStream[R, E, O]

    Permalink

    Takes the specified number of elements from this stream.

  175. def takeUntil(pred: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

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

  176. def takeWhile(pred: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

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

  177. final def tap[R1 <: R, E1 >: E](f0: (O) ⇒ ZIO[R1, E1, Any]): ZStream[R1, E1, O]

    Permalink

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

  178. final def throttleEnforce(units: Long, duration: Duration, burst: Long = 0)(costFn: (Chunk[O]) ⇒ Long): ZStream[R with Clock, E, O]

    Permalink

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

    Throttles the chunks of this stream 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.

  179. final def throttleEnforceM[R1 <: R, E1 >: E](units: Long, duration: Duration, burst: Long = 0)(costFn: (Chunk[O]) ⇒ ZIO[R1, E1, Long]): ZStream[R1 with Clock, E1, O]

    Permalink

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

    Throttles the chunks of this stream 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.

  180. final def throttleShape(units: Long, duration: Duration, burst: Long = 0)(costFn: (Chunk[O]) ⇒ Long): ZStream[R with Clock, E, O]

    Permalink

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

    Delays the chunks of this stream 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.

  181. final def throttleShapeM[R1 <: R, E1 >: E](units: Long, duration: Duration, burst: Long = 0)(costFn: (Chunk[O]) ⇒ ZIO[R1, E1, Long]): ZStream[R1 with Clock, E1, O]

    Permalink

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

    Delays the chunks of this stream 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.

  182. final def timeout(d: Duration): ZStream[R with Clock, E, O]

    Permalink

    Ends the stream if it does not produce a value after d duration.

  183. final def timeoutError[E1 >: E](e: E1)(d: Duration): ZStream[R with Clock, E1, O]

    Permalink

    Fails the stream with given error if it does not produce a value after d duration.

  184. final def timeoutErrorCause[E1 >: E](cause: Cause[E1])(d: Duration): ZStream[R with Clock, E1, O]

    Permalink

    Halts the stream with given cause if it does not produce a value after d duration.

  185. final def timeoutTo[R1 <: R, E1 >: E, O2 >: O](d: Duration)(that: ZStream[R1, E1, O2]): ZStream[R1 with Clock, E1, O2]

    Permalink

    Switches the stream if it does not produce a value after d duration.

  186. def toInputStream(implicit ev0: <:<[E, Throwable], ev1: <:<[O, Byte]): ZManaged[R, E, InputStream]

    Permalink

    Converts this stream of bytes into a java.io.InputStream wrapped in a ZManaged.

    Converts this stream of bytes into a java.io.InputStream wrapped in a ZManaged. The returned input stream will only be valid within the scope of the ZManaged.

  187. def toIterator: ZManaged[R, Nothing, Iterator[Either[E, O]]]

    Permalink

    Converts this stream into a scala.collection.Iterator wrapped in a ZManaged.

    Converts this stream into a scala.collection.Iterator wrapped in a ZManaged. The returned iterator will only be valid within the scope of the ZManaged.

  188. final def toQueue(capacity: Int = 2): ZManaged[R, Nothing, Dequeue[Exit[Option[E], Chunk[O]]]]

    Permalink

    Converts the stream to a managed queue of chunks.

    Converts the stream to a managed queue of chunks. After the managed queue is used, the queue will never again produce values and should be discarded.

  189. final def toQueueUnbounded: ZManaged[R, Nothing, Dequeue[Exit[Option[E], Chunk[O]]]]

    Permalink

    Converts the stream into an unbounded managed queue.

    Converts the stream into an unbounded managed queue. After the managed queue is used, the queue will never again produce values and should be discarded.

  190. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  191. def transduce[R1 <: R, E1 >: E, O3](transducer: ZTransducer[R1, E1, O, O3]): ZStream[R1, E1, O3]

    Permalink

    Applies the transducer to the stream and emits its outputs.

  192. final def via[R2, E2, O2](f: (ZStream[R, E, O]) ⇒ ZStream[R2, E2, O2]): ZStream[R2, E2, O2]

    Permalink

    Threads the stream through the transformation function f.

  193. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  194. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  195. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  196. def withFilter(predicate: (O) ⇒ Boolean): ZStream[R, E, O]

    Permalink

    Equivalent to filter but enables the use of filter clauses in for-comprehensions

  197. def zip[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, (O, O2)]

    Permalink

    Zips this stream with another point-wise and emits tuples of elements from both streams.

    Zips this stream with another point-wise and emits tuples of elements from both streams.

    The new stream will end when one of the sides ends.

  198. def zipAll[R1 <: R, E1 >: E, O1 >: O, O2](that: ZStream[R1, E1, O2])(defaultLeft: O1, defaultRight: O2): ZStream[R1, E1, (O1, O2)]

    Permalink

    Zips this stream with another point-wise, creating a new stream of pairs of elements from both sides.

    Zips this stream with another point-wise, creating a new stream of pairs of elements from both sides.

    The defaults defaultLeft and defaultRight will be used if the streams have different lengths and one of the streams has ended before the other.

  199. def zipAllLeft[R1 <: R, E1 >: E, O1 >: O, O2](that: ZStream[R1, E1, O2])(default: O1): ZStream[R1, E1, O1]

    Permalink

    Zips this stream with another point-wise, and keeps only elements from this stream.

    Zips this stream with another point-wise, and keeps only elements from this stream.

    The provided default value will be used if the other stream ends before this one.

  200. def zipAllRight[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2])(default: O2): ZStream[R1, E1, O2]

    Permalink

    Zips this stream with another point-wise, and keeps only elements from the other stream.

    Zips this stream with another point-wise, and keeps only elements from the other stream.

    The provided default value will be used if this stream ends before the other one.

  201. def zipAllWith[R1 <: R, E1 >: E, O2, O3](that: ZStream[R1, E1, O2])(left: (O) ⇒ O3, right: (O2) ⇒ O3)(both: (O, O2) ⇒ O3): ZStream[R1, E1, O3]

    Permalink

    Zips this stream with another point-wise.

    Zips this stream with another point-wise. The provided functions will be used to create elements for the composed stream.

    The functions left and right will be used if the streams have different lengths and one of the streams has ended before the other.

  202. def zipLeft[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O]

    Permalink

    Zips this stream with another point-wise, but keeps only the outputs of this stream.

    Zips this stream with another point-wise, but keeps only the outputs of this stream.

    The new stream will end when one of the sides ends.

  203. def zipRight[R1 <: R, E1 >: E, O2](that: ZStream[R1, E1, O2]): ZStream[R1, E1, O2]

    Permalink

    Zips this stream with another point-wise, but keeps only the outputs of the other stream.

    Zips this stream with another point-wise, but keeps only the outputs of the other stream.

    The new stream will end when one of the sides ends.

  204. def zipWith[R1 <: R, E1 >: E, O2, O3](that: ZStream[R1, E1, O2])(f: (O, O2) ⇒ O3): ZStream[R1, E1, O3]

    Permalink

    Zips this stream with another point-wise and applies the function to the paired elements.

    Zips this stream with another point-wise and applies the function to the paired elements.

    The new stream will end when one of the sides ends.

  205. final def zipWithIndex: ZStream[R, E, (O, Long)]

    Permalink

    Zips this stream together with the index of elements.

  206. final def zipWithLatest[R1 <: R, E1 >: E, O2, O3](that: ZStream[R1, E1, O2])(f: (O, O2) ⇒ O3): ZStream[R1, E1, O3]

    Permalink

    Zips the two streams so that when a value is emitted by either of the two streams, it is combined with the latest value from the other stream to produce a result.

    Zips the two streams so that when a value is emitted by either of the two streams, it is combined with the latest value from the other stream to produce a result.

    Note: tracking the latest value is done on a per-chunk basis. That means that emitted elements that are not the last value in chunks will never be used for zipping.

Inherited from AnyRef

Inherited from Any

Ungrouped