Object/Class

fs2

Stream

Related Docs: class Stream | package fs2

Permalink

object Stream extends Streams[Stream] with StreamDerived

Source
Stream.scala
Linear Supertypes
StreamDerived, PipeDerived, Streams[Stream], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Stream
  2. StreamDerived
  3. PipeDerived
  4. Streams
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AsyncStep[F[_], A] = Future[F, Pull[F, Nothing, Step[Chunk[A], Handle[F, A]]]]

    Permalink
    Definition Classes
    Streams
  2. type AsyncStep1[F[_], A] = Future[F, Pull[F, Nothing, Step[Option[A], Handle[F, A]]]]

    Permalink
    Definition Classes
    Streams
  3. class Handle[+F[_], +O] extends AnyRef

    Permalink
  4. implicit class HandleInvariantEffectOps[F[_], +A] extends AnyRef

    Permalink
    Definition Classes
    StreamDerived
  5. implicit class HandleOps[+F[_], +A] extends AnyRef

    Permalink
    Definition Classes
    StreamDerived
  6. implicit class PipeOps[F[_], I, O] extends AnyRef

    Permalink

    Provides operations on effectful pipes for syntactic convenience.

    Provides operations on effectful pipes for syntactic convenience.

    Definition Classes
    PipeDerived
  7. type Pull[+F[_], +W, +R] = fs2.Pull[F, W, R]

    Permalink
    Definition Classes
    StreamStreams
  8. implicit class PurePipeOps[I, O] extends AnyRef

    Permalink

    Provides operations on pure pipes for syntactic convenience.

    Provides operations on pure pipes for syntactic convenience.

    Definition Classes
    PipeDerived
  9. implicit class StreamInvariantOps[F[_], A] extends AnyRef

    Permalink
    Definition Classes
    StreamDerived
  10. implicit class StreamPureOps[+A] extends AnyRef

    Permalink
    Definition Classes
    StreamDerived

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 Handle

    Permalink
  5. val Pull: fs2.Pull.type

    Permalink
    Definition Classes
    StreamStreams
  6. def append[F[_], A](a: Stream[F, A], b: ⇒ Stream[F, A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamStreams
  7. def apply[F[_], W](a: W*): Stream[F, W]

    Permalink
    Definition Classes
    StreamDerived
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def attemptEval[F[_], A](fa: F[A]): Stream[F, Either[Throwable, A]]

    Permalink
    Definition Classes
    StreamStreams
  10. implicit def autoCovaryPurePipe[F[_], I, O](p: Pipe[Pure, I, O]): Pipe[F, I, O]

    Permalink
    Definition Classes
    PipeDerived
  11. implicit def autoCovaryPurePipe2[F[_], I, I2, O](p: Pipe2[Pure, I, I2, O]): Pipe2[F, I, I2, O]

    Permalink
    Definition Classes
    PipeDerived
  12. def await[F[_], W](h: Handle[F, W]): Pull[F, Nothing, Step[Chunk[W], Handle[F, W]]]

    Permalink
    Definition Classes
    StreamStreams
  13. def await1[F[_], A](h: Handle[F, A]): Pull[F, Nothing, Step[A, Handle[F, A]]]

    Permalink
    Definition Classes
    StreamDerived
  14. def await1Async[F[_], A](h: Handle[F, A])(implicit F: Async[F]): Pull[F, Nothing, AsyncStep1[F, A]]

    Permalink
    Definition Classes
    StreamDerived
  15. def awaitAsync[F[_], W](h: Handle[F, W])(implicit F: Async[F]): Pull[F, Nothing, AsyncStep[F, W]]

    Permalink
    Definition Classes
    StreamStreams
  16. def bracket[F[_], R, A](r: F[R])(use: (R) ⇒ Stream[F, A], release: (R) ⇒ F[Unit]): Stream[F, A]

    Permalink
    Definition Classes
    StreamStreams
  17. def chunk[F[_], A](as: Chunk[A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamStreams
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def cons[F[_], O](h: Stream[F, O])(c: Chunk[O]): Stream[F, O]

    Permalink
    Definition Classes
    StreamStreams
  20. def constant[F[_], W](w: W, chunkSize: Int = 1): Stream[F, W]

    Permalink

    The infinite Process, always emits a.

    The infinite Process, always emits a. If for performance reasons it is good to emit a in chunks, specify size of chunk by chunkSize parameter

    Definition Classes
    StreamDerived
  21. implicit def covaryPure[F[_], A](s: Stream[Pure, A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  22. def drain[F[_], A](p: Stream[F, A]): Stream[F, Nothing]

    Permalink
    Definition Classes
    StreamDerived
  23. def emit[F[_], A](a: A): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  24. def emits[F[_], W](a: Seq[W]): Stream[F, W]

    Permalink
    Definition Classes
    StreamDerived
  25. def empty[F[_], A]: Stream[F, A]

    Permalink
    Definition Classes
    Streams
  26. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def eval[F[_], A](fa: F[A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  29. def evalScope[F[_], A](fa: Scope[F, A]): Stream[F, A]

    Permalink
  30. def eval_[F[_], A](fa: F[A]): Stream[F, Nothing]

    Permalink
    Definition Classes
    StreamDerived
  31. def fail[F[_]](e: Throwable): Stream[F, Nothing]

    Permalink
    Definition Classes
    StreamStreams
  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def flatMap[F[_], O, O2](s: Stream[F, O])(f: (O) ⇒ Stream[F, O2]): Stream[F, O2]

    Permalink
    Definition Classes
    StreamStreams
  34. def force[F[_], A](f: F[Stream[F, A]]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  35. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  36. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  38. def iterate[F[_], A](start: A)(f: (A) ⇒ A): Stream[F, A]

    Permalink

    An infinite Stream that repeatedly applies a given function to a start value.

    An infinite Stream that repeatedly applies a given function to a start value. start is the first value emitted, followed by f(start), then f(f(start)), and so on.

    Definition Classes
    StreamDerived
  39. def iterateEval[F[_], A](start: A)(f: (A) ⇒ F[A]): Stream[F, A]

    Permalink

    Like iterate, but takes an effectful function for producing the next state.

    Like iterate, but takes an effectful function for producing the next state. start is the first value emitted.

    Definition Classes
    StreamDerived
  40. def map[F[_], A, B](a: Stream[F, A])(f: (A) ⇒ B): Stream[F, B]

    Permalink
    Definition Classes
    StreamDerived
  41. def mask[F[_], A](a: Stream[F, A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  42. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  43. def noneTerminate[F[_], A](p: Stream[F, A]): Stream[F, Option[A]]

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

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

    Permalink
    Definition Classes
    AnyRef
  46. def onComplete[F[_], A](p: Stream[F, A], regardless: ⇒ Stream[F, A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  47. def onError[F[_], O](s: Stream[F, O])(h: (Throwable) ⇒ Stream[F, O]): Stream[F, O]

    Permalink
    Definition Classes
    StreamStreams
  48. def open[F[_], O](s: Stream[F, O]): fs2.Pull[Nothing, Nothing, Handle[F, O]]

    Permalink

    Open a Stream for transformation.

    Open a Stream for transformation. Guaranteed to return a non-done Pull.

    Definition Classes
    StreamStreams
  49. def peek[F[_], A](h: Handle[F, A]): Pull[F, Nothing, Step[Chunk[A], Handle[F, A]]]

    Permalink
    Definition Classes
    StreamDerived
  50. def peek1[F[_], A](h: Handle[F, A]): Pull[F, Nothing, Step[A, Handle[F, A]]]

    Permalink
    Definition Classes
    StreamDerived
  51. def pull[F[_], F2[_], A, B](s: Stream[F, A])(using: (Handle[F, A]) ⇒ Pull[F2, B, Any])(implicit S: Sub1[F, F2]): Stream[F2, B]

    Permalink
    Definition Classes
    StreamDerived
  52. def pure[W](a: W*): Stream[Pure, W]

    Permalink
    Definition Classes
    StreamDerived
  53. def push[F[_], W](h: Handle[F, W])(c: Chunk[W]): Handle[F, W]

    Permalink
    Definition Classes
    StreamStreams
  54. def push1[F[_], A](h: Handle[F, A])(a: A): Handle[F, A]

    Permalink
    Definition Classes
    StreamDerived
  55. def range[F[_]](start: Int, stopExclusive: Int, by: Int = 1): Stream[F, Int]

    Permalink

    Lazily produce the range [start, stopExclusive).

    Lazily produce the range [start, stopExclusive). If you want to produce the sequence in one chunk, instead of lazily, use emits(start until stopExclusive).

    Definition Classes
    StreamDerived
  56. def ranges[F[_]](start: Int, stopExclusive: Int, size: Int): Stream[F, (Int, Int)]

    Permalink

    Lazily produce a sequence of nonoverlapping ranges, where each range contains size integers, assuming the upper bound is exclusive.

    Lazily produce a sequence of nonoverlapping ranges, where each range contains size integers, assuming the upper bound is exclusive. Example: ranges(0, 1000, 10) results in the pairs (0, 10), (10, 20), (20, 30) ... (990, 1000)

    Note: The last emitted range may be truncated at stopExclusive. For instance, ranges(0,5,4) results in (0,4), (4,5).

    Definition Classes
    StreamDerived
    Exceptions thrown

    IllegalArgumentException if size <= 0

  57. def repeatEval[F[_], A](a: F[A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  58. def repeatPull[F[_], A, B](s: Stream[F, A])(using: (Handle[F, A]) ⇒ Pull[F, B, Handle[F, A]]): Stream[F, B]

    Permalink
    Definition Classes
    StreamDerived
  59. def repeatPull2[F[_], A, B, C](s: Stream[F, A], s2: Stream[F, B])(using: (Handle[F, A], Handle[F, B]) ⇒ Pull[F, C, (Handle[F, A], Handle[F, B])]): Stream[F, C]

    Permalink
    Definition Classes
    StreamDerived
  60. def runFoldFree[F[_], A, B](p: Stream[F, A], z: B)(f: (B, A) ⇒ B): Free[F, B]

    Permalink
    Definition Classes
    StreamStreams
  61. def runFoldTraceFree[F[_], A, B](t: Trace)(p: Stream[F, A], z: B)(f: (B, A) ⇒ B): Free[F, B]

    Permalink
    Definition Classes
    StreamStreams
  62. def scope[F[_], O](s: Stream[F, O]): Stream[F, O]

    Permalink
  63. def suspend[F[_], A](s: ⇒ Stream[F, A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
  64. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  66. def translate[F[_], G[_], A](s: Stream[F, A])(u: ~>[F, G]): Stream[G, A]

    Permalink
    Definition Classes
    StreamStreams
  67. def unfold[F[_], S, A](s0: S)(f: (S) ⇒ Option[(A, S)]): Stream[F, A]

    Permalink

    Produce a (potentially infinite) stream from an unfold.

    Produce a (potentially infinite) stream from an unfold.

    Definition Classes
    StreamDerived
  68. def unfoldEval[F[_], S, A](s0: S)(f: (S) ⇒ F[Option[(A, S)]]): Stream[F, A]

    Permalink

    Like unfold, but takes an effectful function.

    Like unfold, but takes an effectful function.

    Definition Classes
    StreamDerived
  69. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def emitAll[F[_], A](as: Seq[A]): Stream[F, A]

    Permalink
    Definition Classes
    StreamDerived
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9) use Stream.emits

Inherited from StreamDerived

Inherited from PipeDerived

Inherited from Streams[Stream]

Inherited from AnyRef

Inherited from Any

Ungrouped