Object/Class

zio.stream

ZPipeline

Related Docs: class ZPipeline | package stream

Permalink

object ZPipeline extends ZPipelinePlatformSpecificConstructors

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZPipeline
  2. ZPipelinePlatformSpecificConstructors
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply[In](implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    A shorter version of ZPipeline.identity, which can facilitate more compact definition of pipelines.

    A shorter version of ZPipeline.identity, which can facilitate more compact definition of pipelines.

    ZPipeline[Int] >>> ZPipeline.filter(_ % 2 != 0)
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def branchAfter[Env, Err, In, Out](n: ⇒ Int)(f: (Chunk[In]) ⇒ ZPipeline[Env, Err, In, Out])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def collect[In, Out](f: PartialFunction[In, Out])(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, Out]

    Permalink

    Creates a pipeline that collects elements with the specified partial function.

    Creates a pipeline that collects elements with the specified partial function.

    ZPipeline.collect[Option[Int], Int] { case Some(v) => v }
  9. def deflate(bufferSize: ⇒ Int = 64 * 1024, noWrap: ⇒ Boolean = false, level: ⇒ CompressionLevel = CompressionLevel.DefaultCompression, strategy: ⇒ CompressionStrategy = CompressionStrategy.DefaultStrategy, flushMode: ⇒ FlushMode = FlushMode.NoFlush)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, Byte]

    Permalink
  10. def drop[In](n: ⇒ Int)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that drops n elements.

  11. def dropUntil[In](f: (In) ⇒ Boolean)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that drops elements until the specified predicate evaluates to true.

    Creates a pipeline that drops elements until the specified predicate evaluates to true.

    ZPipeline.dropUntil[Int](_ > 100)
  12. def dropWhile[In](f: (In) ⇒ Boolean)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that drops elements while the specified predicate evaluates to true.

    Creates a pipeline that drops elements while the specified predicate evaluates to true.

    ZPipeline.dropWhile[Int](_ <= 100)
  13. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. def filter[In](f: (In) ⇒ Boolean)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that filters elements according to the specified predicate.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def fromChannel[Env, Err, In, Out](channel: ⇒ ZChannel[Env, Nothing, Chunk[In], Any, Err, Chunk[Out], Any]): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that sends all the elements through the given channel.

  18. def fromPush[Env, Err, In, Out](push: ⇒ ZManaged[Env, Nothing, (Option[Chunk[In]]) ⇒ ZIO[Env, Err, Chunk[Out]]])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline from a chunk processing function.

  19. def fromSink[Env, Err, In, Out](sink: ZSink[Env, Err, In, In, Out])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that repeatedly sends all elements through the given sink.

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. def groupAdjacentBy[In, Key](f: (In) ⇒ Key)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, (Key, NonEmptyChunk[In])]

    Permalink

    Creates a pipeline that groups on adjacent keys, calculated by function f.

  22. def gunzip[Env](bufferSize: ⇒ Int = 64 * 1024)(implicit trace: ZTraceElement): ZPipeline[Any, CompressionException, Byte, Byte]

    Permalink
  23. def gzip(bufferSize: ⇒ Int = 64 * 1024, level: ⇒ CompressionLevel = CompressionLevel.DefaultCompression, strategy: ⇒ CompressionStrategy = CompressionStrategy.DefaultStrategy, flushMode: ⇒ FlushMode = FlushMode.NoFlush)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, Byte]

    Permalink
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. def identity[In](implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    The identity pipeline, which does not modify streams in any way.

  26. def inflate(bufferSize: ⇒ Int = 64 * 1024, noWrap: ⇒ Boolean = false)(implicit trace: ZTraceElement): ZPipeline[Any, CompressionException, Byte, Byte]

    Permalink
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def iso_8859_1Decode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  29. def iso_8859_1Encode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  30. def map[In, Out](f: (In) ⇒ Out)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, Out]

    Permalink

    Creates a pipeline that maps elements with the specified function.

  31. def mapAccum[In, State, Out](s: ⇒ State)(f: (State, In) ⇒ (State, Out))(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, Out]

    Permalink

    Creates a pipeline that statefully maps elements with the specified function.

  32. def mapAccumZIO[Env, Err, In, State, Out](s: ⇒ State)(f: (State, In) ⇒ ZIO[Env, Err, (State, Out)])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that statefully maps elements with the specified effect.

  33. def mapChunks[In, Out](f: (Chunk[In]) ⇒ Chunk[Out])(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, Out]

    Permalink

    Creates a pipeline that maps chunks of elements with the specified function.

  34. def mapChunksZIO[Env, Err, In, Out](f: (Chunk[In]) ⇒ ZIO[Env, Err, Chunk[Out]])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that maps chunks of elements with the specified effect.

  35. def mapZIO[Env, Err, In, Out](f: (In) ⇒ ZIO[Env, Err, Out])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that maps elements with the specified effectful function.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  39. def prepend[In](values: ⇒ Chunk[In])(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Emits the provided chunk before emitting any other value.

  40. def rechunk[In](n: ⇒ Int)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    A pipeline that rechunks the stream into chunks of the specified size.

  41. def scan[In, Out](s: ⇒ Out)(f: (Out, In) ⇒ Out)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, Out]

    Permalink

    Creates a pipeline that scans elements with the specified function.

  42. def scanZIO[Env, Err, In, Out](s: ⇒ Out)(f: (Out, In) ⇒ ZIO[Env, Err, Out])(implicit trace: ZTraceElement): ZPipeline[Env, Err, In, Out]

    Permalink

    Creates a pipeline that scans elements with the specified function.

  43. def splitLines(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, String]

    Permalink

    Splits strings on newlines.

    Splits strings on newlines. Handles both Windows newlines (\r\n) and UNIX newlines (\n).

  44. def splitOn(delimiter: ⇒ String)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, String]

    Permalink

    Splits strings on a delimiter.

  45. def splitOnChunk[In](delimiter: ⇒ Chunk[In])(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Splits strings on a delimiter.

  46. def suspend[Env, Err, In, Out](pipeline: ⇒ ZPipeline[Env, Err, In, Out]): ZPipeline[Env, Err, In, Out]

    Permalink

    Lazily constructs a pipeline.

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

    Permalink
    Definition Classes
    AnyRef
  48. def take[In](n: ⇒ Long)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that takes n elements.

  49. def takeUntil[In](f: (In) ⇒ Boolean)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that takes elements until the specified predicate evaluates to true.

  50. def takeWhile[In](f: (In) ⇒ Boolean)(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, In, In]

    Permalink

    Creates a pipeline that takes elements while the specified predicate evaluates to true.

  51. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  52. def usASCIIDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  53. def usASCIIEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  54. def utf16BEDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  55. def utf16BEEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  56. def utf16BEWithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  57. def utf16Decode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  58. def utf16Encode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  59. def utf16LEDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  60. def utf16LEEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  61. def utf16LEWithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  62. def utf16WithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  63. def utf32BEDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  64. def utf32BEEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  65. def utf32BEWithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  66. def utf32Decode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  67. def utf32Encode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  68. def utf32LEDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  69. def utf32LEEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  70. def utf32LEWithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  71. def utf32WithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  72. def utf8Decode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink
  73. def utf8Encode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink

    utf*Encode pipelines adhere to the same behavior of Java's String#getBytes(charset), that is:

    utf*Encode pipelines adhere to the same behavior of Java's String#getBytes(charset), that is:

    • utf8: No BOM
    • utf16: Has BOM (the outlier)
    • utf16BE & utf16LE: No BOM
    • All utf32 variants: No BOM

    If BOM is required, users can use the *WithBomEncode variants. (As alluded above, utf16Encode always prepends BOM, just like getBytes("UTF-16") in Java. In fact, it is an alias to both utf16BEWithBomEncode and utf16WithBomEncode.

  74. def utf8WithBomEncode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, String, Byte]

    Permalink
  75. def utfDecode(implicit trace: ZTraceElement): ZPipeline[Any, Nothing, Byte, String]

    Permalink

    utfDecode determines the right encoder to use based on the Byte Order Mark (BOM).

    utfDecode determines the right encoder to use based on the Byte Order Mark (BOM). If it doesn't detect one, it defaults to utf8Decode. In the case of utf16 and utf32 without BOM, utf16Decode and utf32Decode should be used instead as both default to their own default decoder respectively.

  76. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped