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.  final def await[A]: ZSink[Any, Unit, Nothing, A, A]

   Creates a sink that waits for a single value to be produced.

6.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

7.  final def collectAll[A]: ZSink[Any, Nothing, Nothing, A, List[A]]

   Creates a sink accumulating incoming values into a list.

8.  final def collectAllN[A](n: Long): ZSink[Any, Nothing, A, A, List[A]]

   Creates a sink accumulating incoming values into a list of maximum size n.

9.  final def collectAllToMap[K, A](key: (A) ⇒ K): ZSink[Any, Nothing, Nothing, A, Map[K, A]]

   Creates a sink accumulating incoming values into a map.

   Creates a sink accumulating incoming values into a map. Key of each element is determined by supplied function.

10.  final def collectAllToMapN[K, A](n: Long)(key: (A) ⇒ K): Sink[Nothing, A, A, Map[K, A]]

    Creates a sink accumulating incoming values into a map of maximum size n.

    Creates a sink accumulating incoming values into a map of maximum size n. Key of each element is determined by supplied function.

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

    Creates a sink accumulating incoming values into a set.

12.  final def collectAllToSetN[A](n: Long): ZSink[Any, Nothing, A, A, Set[A]]

    Creates a sink accumulating incoming values into a set of maximum size n.

13.  final def collectAllWhile[A](p: (A) ⇒ Boolean): ZSink[Any, Nothing, A, A, List[A]]

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

14.  final def collectAllWhileM[R, E, A](p: (A) ⇒ ZIO[R, E, Boolean]): ZSink[R, E, A, A, List[A]]

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

15.  final def die(e: Throwable): ZSink[Any, Nothing, Nothing, Any, Nothing]

    Creates a sink halting with the specified Throwable.

16.  final def dieMessage(m: String): ZSink[Any, Nothing, Nothing, Any, Nothing]

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

17.  final def drain: ZSink[Any, Nothing, Nothing, Any, Unit]

    Creates a sink consuming all incoming values until completion.

18.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

20.  final def fail[E](e: E): ZSink[Any, E, Nothing, Any, Nothing]

    Creates a sink failing with a value of type E.

21.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

22.  final def fold[A0, A, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, A) ⇒ (S, Chunk[A0])): ZSink[Any, Nothing, A0, A, S]

    Creates a sink by folding over a structure of type S.

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

    Creates a sink by folding over a structure of type S.

24.  final def foldLeftM[R, E, A, S](z: S)(f: (S, A) ⇒ ZIO[R, E, S]): ZSink[R, E, Nothing, A, S]

    Creates a sink by effectully folding over a structure of type S.

25.  final def foldM[R, E, A0, A, S](z: S)(contFn: (S) ⇒ Boolean)(f: (S, A) ⇒ ZIO[R, E, (S, Chunk[A0])]): ZSink[R, E, A0, A, S]

    Creates a sink by effectfully folding over a structure of type S.

26.  final def foldUntil[S, A](z: S, max: Long)(f: (S, A) ⇒ S): ZSink[Any, Nothing, A, A, S]

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

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

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

27.  final def foldUntilM[R, E, S, A](z: S, max: Long)(f: (S, A) ⇒ ZIO[R, E, S]): ZSink[R, E, A, A, S]

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

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

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

28.  final def foldWeighted[A, S](z: S)(costFn: (A) ⇒ Long, max: Long)(f: (S, A) ⇒ S): ZSink[Any, Nothing, A, A, S]

    Creates a sink that folds elements of type A 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 A 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 cause the stream to hang. See ZSink.foldWeightedDecompose for a variant that can handle these.

29.  final def foldWeightedDecompose[A, S](z: S)(costFn: (A) ⇒ Long, max: Long, decompose: (A) ⇒ Chunk[A])(f: (S, A) ⇒ S): ZSink[Any, Nothing, A, A, S]

    Creates a sink that folds elements of type A 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 A 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(
       Sink
         .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). The ZSink.foldWeightedDecomposeM allows the decompose function to return a ZIO value, and consequently it allows the sink to fail.

30.  final def foldWeightedDecomposeM[R, R1 <: R, E, E1 >: E, A, S](z: S)(costFn: (A) ⇒ ZIO[R, E, Long], max: Long, decompose: (A) ⇒ ZIO[R, E, Chunk[A]])(f: (S, A) ⇒ ZIO[R1, E1, S]): ZSink[R1, E1, A, A, S]

    Creates a sink that effectfully folds elements of type A 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 A 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. See ZSink.foldWeightedDecompose for an example.

31.  final def foldWeightedM[R, R1 <: R, E, E1 >: E, A, S](z: S)(costFn: (A) ⇒ ZIO[R, E, Long], max: Long)(f: (S, A) ⇒ ZIO[R1, E1, S]): ZSink[R1, E1, A, A, S]

    Creates a sink that effectfully folds elements of type A 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 A 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 cause the stream to hang. See ZSink.foldWeightedDecomposeM for a variant that can handle these.

32.  final def fromEffect[R, E, B](b: ⇒ ZIO[R, E, B]): ZSink[R, E, Nothing, Any, B]

    Creates a single-value sink produced from an effect

33.  final def fromFunction[A, B](f: (A) ⇒ B): ZSink[Any, Unit, Nothing, A, B]

    Creates a sink that purely transforms incoming values.

34.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

35.  final def halt[E](e: Cause[E]): ZSink[Any, E, Nothing, Any, Nothing]

    Creates a sink halting with a specified cause.

36.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

37.  final def identity[A]: ZSink[Any, Unit, Nothing, A, A]

    Creates a sink by that merely passes on incoming values.

38.  final def ignoreWhile[A](p: (A) ⇒ Boolean): ZSink[Any, Nothing, A, A, Unit]

    Creates a sink by starts consuming value as soon as one fails the predicate p.

39.  final def ignoreWhileM[R, E, A](p: (A) ⇒ ZIO[R, E, Boolean]): ZSink[R, E, A, A, Unit]

    Creates a sink by starts consuming value as soon as one fails the effectful predicate p.

40.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

41.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

42.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

43.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

44.  final def pull1[R, R1 <: R, E, A0, A, B](end: ZIO[R1, E, B])(input: (A) ⇒ ZSink[R, E, A0, A, B]): ZSink[R1, E, A0, A, B]

    Returns a sink that must at least perform one extraction or else will "fail" with end.

45.  final def read1[E, A](e: (Option[A]) ⇒ E)(p: (A) ⇒ Boolean): ZSink[Any, E, A, A, A]

    Creates a sink that consumes the first value verifying the predicate p or fails as soon as the sink won't make any more progress.

46.  final val splitLines: ZSink[Any, Nothing, String, String, Chunk[String]]

    Splits strings on newlines.

    Splits strings on newlines. Handles both \r\n and \n.

47.  final val splitLinesChunk: ZSink[Any, Nothing, Chunk[String], Chunk[String], Chunk[String]]

    Merges chunks of strings and splits them on newlines.

    Merges chunks of strings and splits them on newlines. Handles both \r\n and \n.

48.  final def succeed[A, B](b: B): ZSink[Any, Nothing, A, A, B]

    Creates a single-value sink from a value.

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

    Definition Classes

    AnyRef

50.  final def throttleEnforce[A](units: Long, duration: Duration, burst: Long = 0)(costFn: (A) ⇒ Long): ZManaged[Clock, Nothing, ZSink[Clock, Nothing, Nothing, A, Option[A]]]

    Creates a sink which throttles input elements of type A according to the given bandwidth parameters using the token bucket algorithm.

    Creates a sink which throttles input elements of type A according to the given bandwidth parameters using the token bucket algorithm. The sink allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. Elements that do not meet the bandwidth constraints are dropped. The weight of each element is determined by the costFn function. Elements are mapped to Option[A], and None denotes that a given element has been dropped.

51.  final def throttleEnforceM[R, E, A](units: Long, duration: Duration, burst: Long = 0)(costFn: (A) ⇒ ZIO[R, E, Long]): ZManaged[Clock, Nothing, ZSink[R with Clock, E, Nothing, A, Option[A]]]

    Creates a sink which throttles input elements of type A according to the given bandwidth parameters using the token bucket algorithm.

    Creates a sink which throttles input elements of type A according to the given bandwidth parameters using the token bucket algorithm. The sink allows for burst in the processing of elements by allowing the token bucket to accumulate tokens up to a units + burst threshold. Elements that do not meet the bandwidth constraints are dropped. The weight of each element is determined by the costFn effectful function. Elements are mapped to Option[A], and None denotes that a given element has been dropped.

52.  final def throttleShape[A](units: Long, duration: Duration, burst: Long = 0)(costFn: (A) ⇒ Long): ZManaged[Clock, Nothing, ZSink[Clock, Nothing, Nothing, A, A]]

    Creates a sink which delays input elements of type A according to the given bandwidth parameters using the token bucket algorithm.

    Creates a sink which delays input elements of type A according to the given bandwidth parameters using the token bucket algorithm. The sink 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 element is determined by the costFn function.

53.  final def throttleShapeM[R, E, A](units: Long, duration: Duration, burst: Long = 0)(costFn: (A) ⇒ ZIO[R, E, Long]): ZManaged[Clock, Nothing, ZSink[R with Clock, E, Nothing, A, A]]

    Creates a sink which delays input elements of type A according to the given bandwidth parameters using the token bucket algorithm.

    Creates a sink which delays input elements of type A according to the given bandwidth parameters using the token bucket algorithm. The sink 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 element is determined by the costFn effectful function.

54.  def toString(): String

    Definition Classes

    AnyRef → Any

55.  def utf8Decode(bufferSize: Int = ZStreamChunk.DefaultChunkSize): ZSink[Any, Nothing, Byte, Byte, String]

    Decodes individual bytes into a String using UTF-8.

    Decodes individual bytes into a String using UTF-8. Up to bufferSize bytes will be buffered by the sink.

    This sink uses the String constructor's behavior when handling malformed byte sequences.

56.  val utf8DecodeChunk: ZSink[Any, Nothing, Chunk[Byte], Chunk[Byte], String]

    Decodes chunks of bytes into a String.

    Decodes chunks of bytes into a String.

    This sink uses the String constructor's behavior when handling malformed byte sequences.

57.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

58.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

59.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()