Object/Class

zio.stream

ZStream

Related Docs: class ZStream | package stream

Permalink

object ZStream extends ZStreamPlatformSpecificConstructors with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZStream
  2. Serializable
  3. Serializable
  4. ZStreamPlatformSpecificConstructors
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class AccessMPartiallyApplied[R] extends AnyVal

    Permalink
  2. final class AccessPartiallyApplied[R] extends AnyVal

    Permalink
  3. final class AccessStreamPartiallyApplied[R] extends AnyVal

    Permalink
  4. final class GroupBy[-R, +E, +K, +V] extends AnyRef

    Permalink

    Representation of a grouped stream.

    Representation of a grouped stream. This allows to filter which groups will be processed. Once this is applied all groups will be processed in parallel and the results will be merged in arbitrary order.

  5. final class ProvideSomeLayer[R0 <: Has[_], -R, +E, +A] extends AnyVal

    Permalink
  6. type Pull[-R, +E, +A] = ZIO[R, Option[E], A]

    Permalink

    Describes an effectful pull from a stream.

    Describes an effectful pull from a stream. The optionality of the error channel denotes normal termination of the stream when None and an error when Some(e: E).

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 GroupBy

    Permalink
  5. object Pull

    Permalink
  6. def absolve[R, E, A](xs: ZStream[R, E, Either[E, A]]): ZStream[R, E, A]

    Permalink

    Submerges the error case of an Either into the ZStream.

  7. def access[R]: AccessPartiallyApplied[R]

    Permalink

    Accesses the environment of the stream.

  8. def accessM[R]: AccessMPartiallyApplied[R]

    Permalink

    Accesses the environment of the stream in the context of an effect.

  9. def accessStream[R]: AccessStreamPartiallyApplied[R]

    Permalink

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

  10. def apply[R, E, A](pull: ZManaged[R, Nothing, Pull[R, E, A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from a scoped Pull.

  11. def apply[A](as: A*): Stream[Nothing, A]

    Permalink

    Creates a pure stream from a variable list of values

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def bracket[R, E, A](acquire: ZIO[R, E, A])(release: (A) ⇒ ZIO[R, Nothing, Any]): ZStream[R, E, A]

    Permalink

    Creates a stream from a single value that will get cleaned up after the stream is consumed

  14. def bracketExit[R, E, A](acquire: ZIO[R, E, A])(release: (A, Exit[Any, Any]) ⇒ ZIO[R, Nothing, Any]): ZStream[R, E, A]

    Permalink

    Creates a stream from a single value that will get cleaned up after the stream is consumed

  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def crossN[R, E, A, B, C, D, F](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B], zStream3: ZStream[R, E, C], zStream4: ZStream[R, E, D])(f: (A, B, C, D) ⇒ F): ZStream[R, E, F]

    Permalink

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

    Composes the specified streams to create a cartesian product of elements with a specified function. Subsequent stream would be run multiple times, for every combination of elements in the prior streams.

    See also ZStream#zipN[R,E,A,B,C,D,F]* for the more common point-wise variant.

  17. def crossN[R, E, A, B, C, D](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B], zStream3: ZStream[R, E, C])(f: (A, B, C) ⇒ D): ZStream[R, E, D]

    Permalink

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

    Composes the specified streams to create a cartesian product of elements with a specified function. Subsequent stream would be run multiple times, for every combination of elements in the prior streams.

    See also ZStream#zipN[R,E,A,B,C,D]* for the more common point-wise variant.

  18. def crossN[R, E, A, B, C](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B])(f: (A, B) ⇒ C): ZStream[R, E, C]

    Permalink

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

    Composes the specified streams to create a cartesian product of elements with a specified function. Subsequent streams would be run multiple times, for every combination of elements in the prior streams.

    See also ZStream#zipN[R,E,A,B,C]* for the more common point-wise variant.

  19. def die(ex: ⇒ Throwable): Stream[Nothing, Nothing]

    Permalink

    The stream that always dies with the ex.

  20. def dieMessage(msg: ⇒ String): Stream[Nothing, Nothing]

    Permalink

    The stream that always dies with an exception described by msg.

  21. def effectAsync[R, E, A](register: ((ZIO[R, Option[E], A]) ⇒ Unit) ⇒ Unit, outputBuffer: Int = 16): ZStream[R, E, A]

    Permalink

    Creates a stream from an asynchronous callback that can be called multiple times.

    Creates a stream from an asynchronous callback that can be called multiple times. The optionality of the error type E can be used to signal the end of the stream, by setting it to None.

  22. def effectAsyncInterrupt[R, E, A](register: ((ZIO[R, Option[E], A]) ⇒ Unit) ⇒ Either[Canceler[R], ZStream[R, E, A]], outputBuffer: Int = 16): ZStream[R, E, A]

    Permalink

    Creates a stream from an asynchronous callback that can be called multiple times.

    Creates a stream from an asynchronous callback that can be called multiple times. The registration of the callback returns either a canceler or synchronously returns a stream. The optionality of the error type E can be used to signal the end of the stream, by setting it to None.

  23. def effectAsyncM[R, E, A](register: ((ZIO[R, Option[E], A]) ⇒ Unit) ⇒ ZIO[R, E, Any], outputBuffer: Int = 16): ZStream[R, E, A]

    Permalink

    Creates a stream from an asynchronous callback that can be called multiple times The registration of the callback itself returns an effect.

    Creates a stream from an asynchronous callback that can be called multiple times The registration of the callback itself returns an effect. The optionality of the error type E can be used to signal the end of the stream, by setting it to None.

  24. def effectAsyncMaybe[R, E, A](register: ((ZIO[R, Option[E], A]) ⇒ Unit) ⇒ Option[ZStream[R, E, A]], outputBuffer: Int = 16): ZStream[R, E, A]

    Permalink

    Creates a stream from an asynchronous callback that can be called multiple times.

    Creates a stream from an asynchronous callback that can be called multiple times. The registration of the callback can possibly return the stream synchronously. The optionality of the error type E can be used to signal the end of the stream, by setting it to None.

  25. val empty: Stream[Nothing, Nothing]

    Permalink

    The empty stream

  26. def environment[R]: ZStream[R, Nothing, R]

    Permalink

    Accesses the whole environment of the stream.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. def fail[E](error: ⇒ E): Stream[E, Nothing]

    Permalink

    The stream that always fails with the error

  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def finalizer[R](finalizer: ZIO[R, Nothing, Any]): ZStream[R, Nothing, Nothing]

    Permalink

    Creates an empty stream that never fails and executes the finalizer when it ends.

  32. def flatten[R, E, A](fa: ZStream[R, E, ZStream[R, E, A]]): ZStream[R, E, A]

    Permalink

    Flattens nested streams.

  33. def flattenPar[R, E, A](n: Int, outputBuffer: Int = 16)(fa: ZStream[R, E, ZStream[R, E, A]]): ZStream[R, E, A]

    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.

  34. def flattenParUnbounded[R, E, A](outputBuffer: Int = 16)(fa: ZStream[R, E, ZStream[R, E, A]]): ZStream[R, E, A]

    Permalink

    Like flattenPar, but executes all streams concurrently.

  35. def fromChunk[A](c: ⇒ Chunk[A]): Stream[Nothing, A]

    Permalink

    Creates a stream from a zio.Chunk of values

  36. def fromEffect[R, E, A](fa: ZIO[R, E, A]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing a value of type A

  37. def fromEffectOption[R, E, A](fa: ZIO[R, Option[E], A]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing a value of type A or an empty Stream

  38. def fromInputStream(is: ⇒ InputStream, chunkSize: Int = ZStreamChunk.DefaultChunkSize): StreamEffectChunk[Any, IOException, Byte]

    Permalink

    Creates a stream from a java.io.InputStream

  39. def fromIterable[A](as: ⇒ Iterable[A]): Stream[Nothing, A]

    Permalink

    Creates a stream from an iterable collection of values

  40. def fromIterableM[R, E, A](iterable: ZIO[R, E, Iterable[A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing a value of type Iterable[A]

  41. def fromIterator[R, E, A](iterator: ZIO[R, E, Iterator[A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from an iterator

  42. def fromIteratorManaged[R, E, A](iterator: ZManaged[R, E, Iterator[A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from a managed iterator

  43. def fromJavaIterator[R, E, A](iterator: ZIO[R, E, Iterator[A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from a Java iterator

  44. def fromJavaIteratorManaged[R, E, A](iterator: ZManaged[R, E, Iterator[A]]): ZStream[R, E, A]

    Permalink

    Creates a stream from a managed iterator

  45. def fromQueue[R, E, A](queue: ZQueue[Nothing, Any, R, E, Nothing, A]): ZStream[R, E, A]

    Permalink

    Creates a stream from a zio.ZQueue of values

  46. def fromQueueWithShutdown[R, E, A](queue: ZQueue[Nothing, Any, R, E, Nothing, A]): ZStream[R, E, A]

    Permalink

    Creates a stream from a zio.ZQueue of values.

    Creates a stream from a zio.ZQueue of values. The queue will be shutdown once the stream is closed.

  47. def fromSchedule[R, A](schedule: Schedule[R, Any, A]): ZStream[R, Nothing, A]

    Permalink

    Creates a stream from a zio.Schedule that does not require any further input.

    Creates a stream from a zio.Schedule that does not require any further input. The stream will emit an element for each value output from the schedule, continuing for as long as the schedule continues.

  48. def fromTQueue[A](queue: TQueue[A]): ZStream[Any, Nothing, A]

    Permalink

    Creates a stream from a zio.stm.TQueue of values.

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

    Permalink
    Definition Classes
    AnyRef → Any
  50. def halt[E](cause: ⇒ Cause[E]): ZStream[Any, E, Nothing]

    Permalink

    The stream that always halts with cause.

  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  52. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  53. def iterate[A](a: A)(f: (A) ⇒ A): ZStream[Any, Nothing, A]

    Permalink

    The infinite stream of iterative function application: a, f(a), f(f(a)), f(f(f(a))), ...

  54. def managed[R, E, A](managed: ZManaged[R, E, A]): ZStream[R, E, A]

    Permalink

    Creates a single-valued stream from a managed resource

  55. def mergeAll[R, E, A](n: Int, outputBuffer: Int = 16)(streams: ZStream[R, E, A]*): ZStream[R, E, A]

    Permalink

    Merges a variable list of streams in a non-deterministic fashion.

    Merges a variable list of streams in a non-deterministic fashion. Up to n streams may be consumed in parallel and up to outputBuffer elements may be buffered by this operator.

  56. def mergeAllUnbounded[R, E, A](outputBuffer: Int = 16)(streams: ZStream[R, E, A]*): ZStream[R, E, A]

    Permalink

    Like mergeAll, but runs all streams concurrently.

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

    Permalink
    Definition Classes
    AnyRef
  58. val never: Stream[Nothing, Nothing]

    Permalink

    The stream that never produces any value or fails with any error.

  59. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  61. def paginate[A, S](s: S)(f: (S) ⇒ (A, Option[S])): Stream[Nothing, A]

    Permalink

    Like unfold, but allows the emission of values to end one step further the unfolding of the state.

    Like unfold, but allows the emission of values to end one step further the unfolding of the state. This is useful for embedding paginated APIs, hence the name.

  62. def paginateM[R, E, A, S](s: S)(f: (S) ⇒ ZIO[R, E, (A, Option[S])]): ZStream[R, E, A]

    Permalink

    Like unfoldM, but allows the emission of values to end one step further than the unfolding of the state.

    Like unfoldM, but allows the emission of values to end one step further than the unfolding of the state. This is useful for embedding paginated APIs, hence the name.

  63. def range(min: Int, max: Int): Stream[Nothing, Int]

    Permalink

    Constructs a stream from a range of integers (lower bound included, upper bound not included)

  64. def repeatEffect[R, E, A](fa: ZIO[R, E, A]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing a value of type A which repeats forever

  65. def repeatEffectOption[R, E, A](fa: ZIO[R, Option[E], A]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing values of type A until it fails with None.

  66. def repeatEffectWith[R, E, A](fa: ZIO[R, E, A], schedule: Schedule[R, Unit, _]): ZStream[R, E, A]

    Permalink

    Creates a stream from an effect producing a value of type A which repeats using the specified schedule

  67. def succeed[A](a: ⇒ A): Stream[Nothing, A]

    Permalink

    Creates a single-valued pure stream

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

    Permalink
    Definition Classes
    AnyRef
  69. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  70. def unfold[S, A](s: S)(f0: (S) ⇒ Option[(A, S)]): Stream[Nothing, A]

    Permalink

    Creates a stream by peeling off the "layers" of a value of type S

  71. def unfoldM[R, E, A, S](s: S)(f0: (S) ⇒ ZIO[R, E, Option[(A, S)]]): ZStream[R, E, A]

    Permalink

    Creates a stream by effectfully peeling off the "layers" of a value of type S

  72. val unit: Stream[Nothing, Unit]

    Permalink

    The stream of units

  73. def unwrap[R, E, A](fa: ZIO[R, E, ZStream[R, E, A]]): ZStream[R, E, A]

    Permalink

    Creates a stream produced from an effect

  74. def unwrapManaged[R, E, A](fa: ZManaged[R, E, ZStream[R, E, A]]): ZStream[R, E, A]

    Permalink

    Creates a stream produced from a ZManaged

  75. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  78. def zipN[R, E, A, B, C, D, F](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B], zStream3: ZStream[R, E, C], zStream4: ZStream[R, E, D])(f: (A, B, C, D) ⇒ F): ZStream[R, E, F]

    Permalink

    Returns an effect that executes the specified effects in parallel, combining their results with the specified f function.

    Returns an effect that executes the specified effects in parallel, combining their results with the specified f function. If any effect fails, then the other effects will be interrupted.

  79. def zipN[R, E, A, B, C, D](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B], zStream3: ZStream[R, E, C])(f: (A, B, C) ⇒ D): ZStream[R, E, D]

    Permalink

    Zips with specified streams together with the specified function.

  80. def zipN[R, E, A, B, C](zStream1: ZStream[R, E, A], zStream2: ZStream[R, E, B])(f: (A, B) ⇒ C): ZStream[R, E, C]

    Permalink

    Zips the specified streams together with the specified function.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped