object ZSink extends ZSinkPlatformSpecificConstructors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZSink
  2. ZSinkPlatformSpecificConstructors
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class EnvironmentWithSinkPartiallyApplied[R] extends AnyVal

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def collectAll[In](implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, Chunk[In]]
  7. def collectAllN[In](n: => Int)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Chunk[In]]

    A sink that collects first n elements into a chunk.

    A sink that collects first n elements into a chunk. Note that the chunk is preallocated and must fit in memory.

  8. def collectAllToMap[In, K](key: (In) => K)(f: (In, In) => In)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, Map[K, In]]

    A sink that collects all of its inputs into a map.

    A sink that collects all of its inputs into a map. The keys are extracted from inputs using the keying function key; if multiple inputs use the same key, they are merged using the f function.

  9. def collectAllToMapN[Err, In, K](n: => Long)(key: (In) => K)(f: (In, In) => In)(implicit trace: ZTraceElement): ZSink[Any, Err, In, In, Map[K, In]]

    A sink that collects first n keys into a map.

    A sink that collects first n keys into a map. The keys are calculated from inputs using the keying function key; if multiple inputs use the the same key, they are merged using the f function.

  10. def collectAllToSet[In](implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, Set[In]]

    A sink that collects all of its inputs into a set.

  11. def collectAllToSetN[In](n: => Long)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Set[In]]

    A sink that collects first n distinct inputs into a set.

  12. def collectAllWhile[In](p: (In) => Boolean)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Chunk[In]]

    Accumulates incoming elements into a chunk as long as they verify predicate p.

  13. def collectAllWhileZIO[Env, Err, In](p: (In) => ZIO[Env, Err, Boolean])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, Chunk[In]]

    Accumulates incoming elements into a chunk as long as they verify effectful predicate p.

  14. def count(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Long]

    A sink that counts the number of elements fed to it.

  15. def die(e: => Throwable)(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Nothing]

    Creates a sink halting with the specified Throwable.

  16. def dieMessage(m: => String)(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Nothing]

    Creates a sink halting with the specified message, wrapped in a RuntimeException.

  17. def drain(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Unit]

    A sink that ignores its inputs.

  18. def dropWhile[In](p: (In) => Boolean)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Any]
  19. def dropWhileZIO[R, InErr, In](p: (In) => ZIO[R, InErr, Boolean])(implicit trace: ZTraceElement): ZSink[R, InErr, In, In, Any]
  20. def environmentWithSink[R]: EnvironmentWithSinkPartiallyApplied[R]

    Accesses the environment of the sink in the context of a sink.

  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def fail[E](e: => E)(implicit trace: ZTraceElement): ZSink[Any, E, Any, Nothing, Nothing]

    A sink that always fails with the specified error.

  24. def failCause[E](e: => Cause[E])(implicit trace: ZTraceElement): ZSink[Any, E, Any, Nothing, Nothing]

    Creates a sink halting with a specified cause.

  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. def fold[In, S](z: => S)(contFn: (S) => Boolean)(f: (S, In) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, S]

    A sink that folds its inputs with the provided function, termination predicate and initial state.

  27. def foldChunks[In, S](z: => S)(contFn: (S) => Boolean)(f: (S, Chunk[In]) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, S]

    A sink that folds its input chunks with the provided function, termination predicate and initial state.

    A sink that folds its input chunks with the provided function, termination predicate and initial state. contFn condition is checked only for the initial value and at the end of processing of each chunk. f and contFn must preserve chunking-invariance.

  28. def foldChunksZIO[Env, Err, In, S](z: => S)(contFn: (S) => Boolean)(f: (S, Chunk[In]) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    A sink that effectfully folds its input chunks with the provided function, termination predicate and initial state.

    A sink that effectfully folds its input chunks with the provided function, termination predicate and initial state. contFn condition is checked only for the initial value and at the end of processing of each chunk. f and contFn must preserve chunking-invariance.

  29. def foldLeft[In, S](z: => S)(f: (S, In) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, S]

    A sink that folds its inputs with the provided function and initial state.

  30. def foldLeftChunks[In, S](z: => S)(f: (S, Chunk[In]) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, Nothing, S]

    A sink that folds its input chunks with the provided function and initial state.

    A sink that folds its input chunks with the provided function and initial state. f must preserve chunking-invariance.

  31. def foldLeftChunksZIO[R, Err, In, S](z: => S)(f: (S, Chunk[In]) => ZIO[R, Err, S])(implicit trace: ZTraceElement): ZSink[R, Err, In, Nothing, S]

    A sink that effectfully folds its input chunks with the provided function and initial state.

    A sink that effectfully folds its input chunks with the provided function and initial state. f must preserve chunking-invariance.

  32. def foldLeftZIO[R, Err, In, S](z: => S)(f: (S, In) => ZIO[R, Err, S])(implicit trace: ZTraceElement): ZSink[R, Err, In, In, S]

    A sink that effectfully folds its inputs with the provided function and initial state.

  33. def foldUntil[In, S](z: => S, max: => Long)(f: (S, In) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, S]

    Creates a sink that folds elements of type In into a structure of type S until max elements have been folded.

    Creates a sink that folds elements of type In into a structure of type S until max elements have been folded.

    Like foldWeighted, but with a constant cost function of 1.

  34. def foldUntilZIO[Env, Err, In, S](z: => S, max: => Long)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S until max elements have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S until max elements have been folded.

    Like foldWeightedM, but with a constant cost function of 1.

  35. def foldWeighted[In, S](z: => S)(costFn: (S, In) => Long, max: => Long)(f: (S, In) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, S]

    Creates a sink that folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Note

    Elements that have an individual cost larger than max will force the sink to cross the max cost. See foldWeightedDecompose for a variant that can handle these cases.

  36. def foldWeightedDecompose[In, S](z: => S)(costFn: (S, In) => Long, max: => Long, decompose: (In) => Chunk[In])(f: (S, In) => S)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, S]

    Creates a sink that folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    The decompose function will be used for decomposing elements that cause an S aggregate to cross max into smaller elements. For example:

    Stream(1, 5, 1)
  .transduce(
    ZSink
      .foldWeightedDecompose(List[Int]())((i: Int) => i.toLong, 4,
        (i: Int) => Chunk(i - 1, 1)) { (acc, el) =>
        el :: acc
      }
      .map(_.reverse)
  )
  .runCollect

    The stream would emit the elements List(1), List(4), List(1, 1).

    Be vigilant with this function, it has to generate "simpler" values or the fold may never end. A value is considered indivisible if decompose yields the empty chunk or a single-valued chunk. In these cases, there is no other choice than to yield a value that will cross the threshold.

    The foldWeightedDecomposeM allows the decompose function to return a ZIO value, and consequently it allows the sink to fail.

  37. def foldWeightedDecomposeZIO[Env, Err, In, S](z: => S)(costFn: (S, In) => ZIO[Env, Err, Long], max: => Long, decompose: (In) => ZIO[Env, Err, Chunk[In]])(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    The decompose function will be used for decomposing elements that cause an S aggregate to cross max into smaller elements. Be vigilant with this function, it has to generate "simpler" values or the fold may never end. A value is considered indivisible if decompose yields the empty chunk or a single-valued chunk. In these cases, there is no other choice than to yield a value that will cross the threshold.

    See foldWeightedDecompose for an example.

  38. def foldWeightedZIO[Env, Err, In, S](z: => S)(costFn: (S, In) => ZIO[Env, Err, Long], max: Long)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Note

    Elements that have an individual cost larger than max will force the sink to cross the max cost. See foldWeightedDecomposeM for a variant that can handle these cases.

  39. def foldZIO[Env, Err, In, S](z: => S)(contFn: (S) => Boolean)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    A sink that effectfully folds its inputs with the provided function, termination predicate and initial state.

  40. def foreach[R, Err, In](f: (In) => ZIO[R, Err, Any])(implicit trace: ZTraceElement): ZSink[R, Err, In, Nothing, Unit]

    A sink that executes the provided effectful function for every element fed to it.

  41. def foreachChunk[R, Err, In](f: (Chunk[In]) => ZIO[R, Err, Any])(implicit trace: ZTraceElement): ZSink[R, Err, In, Nothing, Unit]

    A sink that executes the provided effectful function for every chunk fed to it.

  42. def foreachChunkWhile[R, Err, In](f: (Chunk[In]) => ZIO[R, Err, Boolean])(implicit trace: ZTraceElement): ZSink[R, Err, In, In, Unit]

    A sink that executes the provided effectful function for every chunk fed to it until f evaluates to false.

  43. final def foreachWhile[R, Err, In](f: (In) => ZIO[R, Err, Boolean])(implicit trace: ZTraceElement): ZSink[R, Err, In, In, Unit]

    A sink that executes the provided effectful function for every element fed to it until f evaluates to false.

  44. def fromHub[R, E, I](hub: => ZHub[R, Nothing, E, Any, I, Any])(implicit trace: ZTraceElement): ZSink[R, E, I, Nothing, Unit]

    Create a sink which publishes each element to the specified hub.

  45. def fromHubWithShutdown[R, E, I](hub: => ZHub[R, Nothing, E, Any, I, Any])(implicit trace: ZTraceElement): ZSink[R, E, I, Nothing, Unit]

    Create a sink which publishes each element to the specified hub.

    Create a sink which publishes each element to the specified hub. The hub will be shutdown once the stream is closed.

  46. def fromQueue[R, E, I](queue: => ZEnqueue[R, E, I])(implicit trace: ZTraceElement): ZSink[R, E, I, Nothing, Unit]

    Create a sink which enqueues each element into the specified queue.

  47. def fromQueueWithShutdown[R, E, I](queue: => ZQueue[R, Nothing, E, Any, I, Any])(implicit trace: ZTraceElement): ZSink[R, E, I, Nothing, Unit]

    Create a sink which enqueues each element into the specified queue.

    Create a sink which enqueues each element into the specified queue. The queue will be shutdown once the stream is closed.

  48. def fromZIO[R, E, Z](b: => ZIO[R, E, Z])(implicit trace: ZTraceElement): ZSink[R, E, Any, Nothing, Z]

    Creates a single-value sink produced from an effect

  49. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. def head[In](implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Option[In]]

    Creates a sink containing the first value.

  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def last[In](implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Option[In]]

    Creates a sink containing the last value.

  54. def leftover[L](c: => Chunk[L])(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, L, Unit]
  55. def mkString(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, String]
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def never(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Nothing]
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. def succeed[Z](z: => Z)(implicit trace: ZTraceElement): ZSink[Any, Nothing, Any, Nothing, Z]

    A sink that immediately ends with the specified value.

  61. def sum[A](implicit A: Numeric[A], trace: ZTraceElement): ZSink[Any, Nothing, A, Nothing, A]

    A sink that sums incoming numeric values.

  62. def suspend[Env, E, In, Leftover, Done](sink: => ZSink[Env, E, In, Leftover, Done])(implicit trace: ZTraceElement): ZSink[Env, E, In, Leftover, Done]

    Returns a lazily constructed sink that may require effects for its creation.

  63. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  64. def take[In](n: Int)(implicit trace: ZTraceElement): ZSink[Any, Nothing, In, In, Chunk[In]]

    A sink that takes the specified number of values.

  65. def timed(implicit trace: ZTraceElement): ZSink[Clock, Nothing, Any, Nothing, zio.Duration]
  66. def toString(): String
    Definition Classes
    AnyRef → Any
  67. def unwrap[R, E, In, L, Z](zio: => ZIO[R, E, ZSink[R, E, In, L, Z]])(implicit trace: ZTraceElement): ZSink[R, E, In, L, Z]

    Creates a sink produced from an effect.

  68. def unwrapManaged[R, E, In, L, Z](managed: => ZManaged[R, E, ZSink[R, E, In, L, Z]])(implicit trace: ZTraceElement): ZSink[R, E, In, L, Z]

    Creates a sink produced from a managed effect.

  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def collectAllWhileM[Env, Err, In](p: (In) => ZIO[Env, Err, Boolean])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, Chunk[In]]

    Accumulates incoming elements into a chunk as long as they verify effectful predicate p.

    Accumulates incoming elements into a chunk as long as they verify effectful predicate p.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use collectAllWhileZIO

  2. def dropWhileM[R, InErr, In](p: (In) => ZIO[R, InErr, Boolean])(implicit trace: ZTraceElement): ZSink[R, InErr, In, In, Any]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use dropWhileZIO

  3. def effectSuspendTotal[Env, E, In, Leftover, Done](sink: => ZSink[Env, E, In, Leftover, Done])(implicit trace: ZTraceElement): ZSink[Env, E, In, Leftover, Done]

    Returns a lazily constructed sink that may require effects for its creation.

    Returns a lazily constructed sink that may require effects for its creation.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use suspend

  4. def effectTotal[A](a: => A)(implicit trace: ZTraceElement): ZSink[Any, Any, Nothing, Nothing, A]

    Returns a sink that executes a total effect and ends with its result.

    Returns a sink that executes a total effect and ends with its result.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use succeed

  5. def foldChunksM[Env, Err, In, S](z: => S)(contFn: (S) => Boolean)(f: (S, Chunk[In]) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    A sink that effectfully folds its input chunks with the provided function, termination predicate and initial state.

    A sink that effectfully folds its input chunks with the provided function, termination predicate and initial state. contFn condition is checked only for the initial value and at the end of processing of each chunk. f and contFn must preserve chunking-invariance.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldChunksZIO

  6. def foldLeftChunksM[R, Err, In, S](z: => S)(f: (S, Chunk[In]) => ZIO[R, Err, S])(implicit trace: ZTraceElement): ZSink[R, Err, In, Nothing, S]

    A sink that effectfully folds its input chunks with the provided function and initial state.

    A sink that effectfully folds its input chunks with the provided function and initial state. f must preserve chunking-invariance.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldLeftChunksZIO

  7. def foldLeftM[R, Err, In, S](z: => S)(f: (S, In) => ZIO[R, Err, S])(implicit trace: ZTraceElement): ZSink[R, Err, In, In, S]

    A sink that effectfully folds its inputs with the provided function and initial state.

    A sink that effectfully folds its inputs with the provided function and initial state.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldLeftZIO

  8. def foldM[Env, Err, In, S](z: => S)(contFn: (S) => Boolean)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    A sink that effectfully folds its inputs with the provided function, termination predicate and initial state.

    A sink that effectfully folds its inputs with the provided function, termination predicate and initial state.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldZIO

  9. def foldUntilM[Env, Err, In, S](z: => S, max: => Long)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S until max elements have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S until max elements have been folded.

    Like foldWeightedM, but with a constant cost function of 1.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldUntilZIO

  10. def foldWeightedDecomposeM[Env, Err, In, S](z: => S)(costFn: (S, In) => ZIO[Env, Err, Long], max: => Long, decompose: (In) => ZIO[Env, Err, Chunk[In]])(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    The decompose function will be used for decomposing elements that cause an S aggregate to cross max into smaller elements. Be vigilant with this function, it has to generate "simpler" values or the fold may never end. A value is considered indivisible if decompose yields the empty chunk or a single-valued chunk. In these cases, there is no other choice than to yield a value that will cross the threshold.

    See foldWeightedDecompose for an example.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldWeightedDecomposeZIO

  11. def foldWeightedM[Env, Err, In, S](z: => S)(costFn: (S, In) => ZIO[Env, Err, Long], max: Long)(f: (S, In) => ZIO[Env, Err, S])(implicit trace: ZTraceElement): ZSink[Env, Err, In, In, S]

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Creates a sink that effectfully folds elements of type In into a structure of type S, until max worth of elements (determined by the costFn) have been folded.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0-) use foldWeightedZIO

    Note

    Elements that have an individual cost larger than max will force the sink to cross the max cost. See foldWeightedDecomposeM for a variant that can handle these cases.

  12. def fromEffect[R, E, Z](b: => ZIO[R, E, Z])(implicit trace: ZTraceElement): ZSink[R, E, Any, Nothing, Z]

    Creates a single-value sink produced from an effect

    Creates a single-value sink produced from an effect

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use fromZIO

  13. def halt[E](e: => Cause[E])(implicit trace: ZTraceElement): ZSink[Any, Any, E, Nothing, Nothing]

    Creates a sink halting with a specified cause.

    Creates a sink halting with a specified cause.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use failCause

  14. def managed[R, E, In, A, L <: In, Z](resource: => ZManaged[R, E, A])(fn: (A) => ZSink[R, E, In, L, Z])(implicit trace: ZTraceElement): ZSink[R, E, In, In, Z]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use unwrapManaged

Inherited from ZSinkPlatformSpecificConstructors

Inherited from AnyRef

Inherited from Any

Ungrouped