Object/Class

zio.stream

ZSink

Related Docs: class ZSink | package stream

Permalink

object ZSink extends ZSinkPlatformSpecificConstructors

Linear Supertypes
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. All

Type Members

  1. final class AccessSinkPartiallyApplied[R] extends AnyVal

    Permalink
  2. type Push[-R, +E, -I, +L, +Z] = (Option[Chunk[I]]) ⇒ ZIO[R, (Either[E, Z], Chunk[L]), Unit]

    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 ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Push

    Permalink
  5. def accessSink[R]: AccessSinkPartiallyApplied[R]

    Permalink

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

  6. def apply[R, E, I, L, Z](push: ZManaged[R, Nothing, Push[R, E, I, L, Z]]): ZSink[R, E, I, L, Z]

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def collectAll[A]: ZSink[Any, Nothing, A, Nothing, Chunk[A]]

    Permalink

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

  10. def collectAllToMap[A, K](key: (A) ⇒ K)(f: (A, A) ⇒ A): ZSink[Any, Nothing, A, Nothing, Map[K, A]]

    Permalink

    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.

  11. def collectAllToSet[A]: ZSink[Any, Nothing, A, Nothing, Set[A]]

    Permalink

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

  12. val count: ZSink[Any, Nothing, Any, Nothing, Long]

    Permalink

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

  13. def die(e: ⇒ Throwable): ZSink[Any, Nothing, Any, Nothing, Nothing]

    Permalink

    Creates a sink halting with the specified Throwable.

  14. def dieMessage(m: ⇒ String): ZSink[Any, Nothing, Any, Nothing, Nothing]

    Permalink

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

  15. val drain: ZSink[Any, Nothing, Any, Nothing, Unit]

    Permalink

    A sink that ignores its inputs.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def fail[E, I](e: ⇒ E): ZSink[Any, E, I, I, Nothing]

    Permalink

    A sink that always fails with the specified error.

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fold[I, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, I) ⇒ S): ZSink[Any, Nothing, I, I, S]

    Permalink

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

  21. def foldChunks[I, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, Chunk[I]) ⇒ S): ZSink[Any, Nothing, I, I, S]

    Permalink

    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.

  22. def foldChunksM[R, E, I, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, Chunk[I]) ⇒ ZIO[R, E, S]): ZSink[R, E, I, I, S]

    Permalink

    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.

  23. def foldLeft[I, S](z: S)(f: (S, I) ⇒ S): ZSink[Any, Nothing, I, Nothing, S]

    Permalink

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

  24. def foldLeftChunks[I, S](z: S)(f: (S, Chunk[I]) ⇒ S): ZSink[Any, Nothing, I, Nothing, S]

    Permalink

    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.

  25. def foldLeftChunksM[R, E, I, S](z: S)(f: (S, Chunk[I]) ⇒ ZIO[R, E, S]): ZSink[R, E, I, Nothing, S]

    Permalink

    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.

  26. def foldLeftM[R, E, I, S](z: S)(f: (S, I) ⇒ ZIO[R, E, S]): ZSink[R, E, I, I, S]

    Permalink

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

  27. def foldM[R, E, I, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, I) ⇒ ZIO[R, E, S]): ZSink[R, E, I, I, S]

    Permalink

    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.

    This sink may terminate in the middle of a chunk and discard the rest of it. See the discussion on the ZSink class scaladoc on sinks vs. transducers.

  28. def foreach[R, E, I](f: (I) ⇒ ZIO[R, E, Any]): ZSink[R, E, I, I, Unit]

    Permalink

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

  29. def foreachChunk[R, E, I](f: (Chunk[I]) ⇒ ZIO[R, E, Any]): ZSink[R, E, I, Nothing, Unit]

    Permalink

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

  30. final def foreachWhile[R, E, I](f: (I) ⇒ ZIO[R, E, Boolean]): ZSink[R, E, I, I, Unit]

    Permalink

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

  31. def fromEffect[R, E, I, Z](b: ⇒ ZIO[R, E, Z]): ZSink[R, E, I, I, Z]

    Permalink

    Creates a single-value sink produced from an effect

  32. final def fromFile(path: ⇒ Path, position: Long = 0L, options: Set[OpenOption] = ...): ZSink[Blocking, Throwable, Byte, Byte, Long]

    Permalink

    Uses the provided Path to create a ZSink that consumes byte chunks and writes them to the File.

    Uses the provided Path to create a ZSink that consumes byte chunks and writes them to the File. The sink will yield count of bytes written.

    Definition Classes
    ZSinkPlatformSpecificConstructors
  33. final def fromOutputStream(os: OutputStream): ZSink[Blocking, IOException, Byte, Byte, Long]

    Permalink

    Uses the provided OutputStream to create a ZSink that consumes byte chunks and writes them to the OutputStream.

    Uses the provided OutputStream to create a ZSink that consumes byte chunks and writes them to the OutputStream. The sink will yield the count of bytes written.

    The caller of this function is responsible for closing the OutputStream.

    Definition Classes
    ZSinkPlatformSpecificConstructors
  34. final def fromOutputStreamManaged(os: ZManaged[Blocking, IOException, OutputStream]): ZSink[Blocking, IOException, Byte, Byte, Long]

    Permalink

    Uses the provided OutputStream resource to create a ZSink that consumes byte chunks and writes them to the OutputStream.

    Uses the provided OutputStream resource to create a ZSink that consumes byte chunks and writes them to the OutputStream. The sink will yield the count of bytes written.

    The OutputStream will be automatically closed after the stream is finished or an error occurred.

    Definition Classes
    ZSinkPlatformSpecificConstructors
  35. def fromPush[R, E, I, L, Z](sink: Push[R, E, I, L, Z]): ZSink[R, E, I, L, Z]

    Permalink
  36. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  37. def halt[E](e: ⇒ Cause[E]): ZSink[Any, E, Any, Nothing, Nothing]

    Permalink

    Creates a sink halting with a specified cause.

  38. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  39. def head[I]: ZSink[Any, Nothing, I, I, Option[I]]

    Permalink

    Creates a sink containing the first value.

  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  41. def last[I]: ZSink[Any, Nothing, I, Nothing, Option[I]]

    Permalink

    Creates a sink containing the last value.

  42. def managed[R, E, I, A, L <: I, Z](resource: ZManaged[R, E, A])(fn: (A) ⇒ ZSink[R, E, I, L, Z]): ZSink[R, E, I, I, Z]

    Permalink

    A sink that depends on another managed value resource will be finalized after the processing.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  46. def succeed[I, Z](z: ⇒ Z): ZSink[Any, Nothing, I, I, Z]

    Permalink

    A sink that immediately ends with the specified value.

  47. def sum[A](implicit A: Numeric[A]): ZSink[Any, Nothing, A, Nothing, A]

    Permalink

    A sink that sums incoming numeric values.

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

    Permalink
    Definition Classes
    AnyRef
  49. def take[I](n: Int): ZSink[Any, Nothing, I, I, Chunk[I]]

    Permalink

    A sink that takes the specified number of values.

  50. def timed: ZSink[Clock, Nothing, Any, Nothing, Duration]

    Permalink

    A sink with timed execution.

  51. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped