Object/Class

fs2

Pull

Related Docs: class Pull | package fs2

Permalink

object Pull extends Pulls[Pull] with PullDerived with pull1

Source
Pull.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pull
  2. pull1
  3. PullDerived
  4. Pulls
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait P[F[_], O] extends AnyRef

    Permalink
  2. sealed trait PF[+F[_], +O, +R] extends AnyRef

    Permalink
  3. type Stream[+F[_], +W] = fs2.Stream[F, W]

    Permalink
    Definition Classes
    PullPulls

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 PF

    Permalink
  5. def acquire[F[_], R](r: F[R])(cleanup: (R) ⇒ F[Unit]): Pull[F, Nothing, R]

    Permalink

    Acquire a resource within a Pull.

    Acquire a resource within a Pull. The cleanup action will be run at the end of the .close scope which executes the returned Pull. The acquired resource is returned as the result value of the pull.

    Definition Classes
    PullDerived
  6. def acquireCancellable[F[_], R](r: F[R])(cleanup: (R) ⇒ F[Unit]): Pull[F, Nothing, (Pull[F, Nothing, Unit], R)]

    Permalink

    Like acquire but the result value is a tuple consisting of a cancellation pull and the acquired resource.

    Like acquire but the result value is a tuple consisting of a cancellation pull and the acquired resource. Running the cancellation pull frees the resource. This allows the acquired resource to be released earlier than at the end of the containing pull scope.

    Definition Classes
    PullDerived
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def attemptEval[F[_], R](f: F[R]): Pull[F, Nothing, Attempt[R]]

    Permalink
  9. def await[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Step[Chunk[I], Handle[F, I]]]

    Permalink

    Await the next available Chunk from the Handle.

    Await the next available Chunk from the Handle. The Chunk may be empty.

    Definition Classes
    pull1
  10. def await1[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Step[I, Handle[F, I]]]

    Permalink

    Await a single element from the Handle.

    Await a single element from the Handle.

    Definition Classes
    pull1
  11. def await1Option[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Option[Step[I, Handle[F, I]]]]

    Permalink

    Await the next available element from the input, or None if the input is exhausted.

    Await the next available element from the input, or None if the input is exhausted.

    Definition Classes
    pull1
  12. def awaitLimit[F[_], I](maxChunkSize: Int): (Handle[F, I]) ⇒ Pull[F, Nothing, Step[Chunk[I], Handle[F, I]]]

    Permalink

    Like await, but return a Chunk of no more than maxChunkSize elements.

    Like await, but return a Chunk of no more than maxChunkSize elements.

    Definition Classes
    pull1
  13. def awaitN[F[_], I](n: Int, allowFewer: Boolean = false): (Handle[F, I]) ⇒ Pull[F, Nothing, Step[List[Chunk[I]], Handle[F, I]]]

    Permalink

    Return a List[Chunk[I]] from the input whose combined size has a maximum value n.

    Return a List[Chunk[I]] from the input whose combined size has a maximum value n.

    Definition Classes
    pull1
  14. def awaitNonempty[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Step[Chunk[I], Handle[F, I]]]

    Permalink

    Await the next available nonempty Chunk.

    Await the next available nonempty Chunk.

    Definition Classes
    pull1
  15. def awaitNonemptyOption[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Option[Step[Chunk[I], Handle[F, I]]]]

    Permalink

    Await the next available non-empty chunk from the input, or None if the input is exhausted.

    Await the next available non-empty chunk from the input, or None if the input is exhausted.

    Definition Classes
    pull1
  16. def awaitOption[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Option[Step[Chunk[I], Handle[F, I]]]]

    Permalink

    Await the next available chunk from the input, or None if the input is exhausted.

    Await the next available chunk from the input, or None if the input is exhausted.

    Definition Classes
    pull1
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def close[F[_], O, R](p: Pull[F, O, R]): Stream[F, O]

    Permalink

    Interpret this Pull to produce a Stream.

    Interpret this Pull to produce a Stream. The result type R is discarded.

    Definition Classes
    PullPulls
  19. def copy[F[_], I]: (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Copy the next available chunk to the output.

    Copy the next available chunk to the output.

    Definition Classes
    pull1
  20. def copy1[F[_], I]: (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Copy the next available element to the output.

    Copy the next available element to the output.

    Definition Classes
    pull1
  21. implicit def covaryPure[F[_], W, R](p: Pull[Pure, W, R]): Pull[F, W, R]

    Permalink
    Definition Classes
    PullDerived
  22. def done: Pull[Nothing, Nothing, Nothing]

    Permalink

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

    Definition Classes
    PullPulls
  23. def drop[F[_], I](n: Long): (Handle[F, I]) ⇒ Pull[F, Nothing, Handle[F, I]]

    Permalink

    Drop the first n elements of the input Handle, and return the new Handle.

    Drop the first n elements of the input Handle, and return the new Handle.

    Definition Classes
    pull1
  24. def dropWhile[F[_], I](p: (I) ⇒ Boolean): (Handle[F, I]) ⇒ Pull[F, Nothing, Handle[F, I]]

    Permalink

    Drop the elements of the input Handle until the predicate p fails, and return the new Handle.

    Drop the elements of the input Handle until the predicate p fails, and return the new Handle. If nonempty, the first element of the returned Handle will fail p.

    Definition Classes
    pull1
  25. def echo[F[_], I]: (Handle[F, I]) ⇒ Pull[F, I, Nothing]

    Permalink

    Write all inputs to the output of the returned Pull.

    Write all inputs to the output of the returned Pull.

    Definition Classes
    pull1
  26. def echo1[F[_], I]: (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Read a single element from the input and emit it to the output.

    Read a single element from the input and emit it to the output. Returns the new Handle.

    Definition Classes
    pull1
  27. def echoChunk[F[_], I]: (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Read the next available chunk from the input and emit it to the output.

    Read the next available chunk from the input and emit it to the output. Returns the new Handle.

    Definition Classes
    pull1
  28. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  30. def eval[F[_], R](f: F[R]): Pull[F, Nothing, R]

    Permalink

    Promote an effect to a Pull.

    Promote an effect to a Pull.

    Definition Classes
    PullPulls
  31. def evalScope[F[_], R](f: Scope[F, R]): Pull[F, Nothing, R]

    Permalink
  32. def fail(err: Throwable): Pull[Nothing, Nothing, Nothing]

    Permalink

    The Pull that reads and outputs nothing, and fails with the given error.

    The Pull that reads and outputs nothing, and fails with the given error.

    Definition Classes
    PullPulls
  33. def fetchN[F[_], I](n: Int): (Handle[F, I]) ⇒ Pull[F, Nothing, Handle[F, I]]

    Permalink

    Like awaitN, but leaves the buffered input unconsumed.

    Like awaitN, but leaves the buffered input unconsumed.

    Definition Classes
    pull1
  34. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def find[F[_], I](f: (I) ⇒ Boolean): (Handle[F, I]) ⇒ Pull[F, Nothing, Step[I, Handle[F, I]]]

    Permalink

    Await the next available element where the predicate returns true

    Await the next available element where the predicate returns true

    Definition Classes
    pull1
  36. def flatMap[F[_], O, R0, R](p: Pull[F, O, R0])(f: (R0) ⇒ Pull[F, O, R]): Pull[F, O, R]

    Permalink

    Monadic bind.

    Monadic bind.

    Definition Classes
    PullPulls
  37. def fold[F[_], I, O](z: O)(f: (O, I) ⇒ O): (Handle[F, I]) ⇒ Pull[F, Nothing, O]

    Permalink

    Folds all inputs using an initial value z and supplied binary operator, and writes the final result to the output of the supplied Pull when the stream has no more values.

    Folds all inputs using an initial value z and supplied binary operator, and writes the final result to the output of the supplied Pull when the stream has no more values.

    Definition Classes
    pull1
  38. def fold1[F[_], I](f: (I, I) ⇒ I): (Handle[F, I]) ⇒ Pull[F, Nothing, I]

    Permalink

    Folds all inputs using the supplied binary operator, and writes the final result to the output of the supplied Pull when the stream has no more values.

    Folds all inputs using the supplied binary operator, and writes the final result to the output of the supplied Pull when the stream has no more values.

    Definition Classes
    pull1
  39. def forall[F[_], I](p: (I) ⇒ Boolean): (Handle[F, I]) ⇒ Pull[F, Nothing, Boolean]

    Permalink

    Write a single true value if all input matches the predicate, false otherwise

    Write a single true value if all input matches the predicate, false otherwise

    Definition Classes
    pull1
  40. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  43. def last[F[_], I]: (Handle[F, I]) ⇒ Pull[F, Nothing, Option[I]]

    Permalink

    Return the last element of the input Handle, if nonempty.

    Return the last element of the input Handle, if nonempty.

    Definition Classes
    pull1
  44. def loop[F[_], W, R](using: (R) ⇒ Pull[F, W, R]): (R) ⇒ Pull[F, W, Nothing]

    Permalink

    Repeatedly use the output of the Pull as input for the next step of the pull.

    Repeatedly use the output of the Pull as input for the next step of the pull. Halts when a step terminates with Pull.done or Pull.fail.

    Definition Classes
    PullDerived
  45. def map[F[_], W, R0, R](p: Pull[F, W, R0])(f: (R0) ⇒ R): Pull[F, W, R]

    Permalink
    Definition Classes
    PullDerived
  46. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  49. def onError[F[_], O, R](p: Pull[F, O, R])(handle: (Throwable) ⇒ Pull[F, O, R]): Pull[F, O, R]

    Permalink

    If p terminates with fail(e), invoke handle(e).

    If p terminates with fail(e), invoke handle(e).

    Definition Classes
    PullPulls
  50. def or[F[_], O, R](p1: Pull[F, O, R], p2: ⇒ Pull[F, O, R]): Pull[F, O, R]

    Permalink

    Consult p2 if p fails due to an await on an exhausted Handle.

    Consult p2 if p fails due to an await on an exhausted Handle. If p fails due to an error, p2 is not consulted.

    Definition Classes
    PullPulls
  51. def output[F[_], W](w: Chunk[W]): Pull[F, W, Unit]

    Permalink

    Write a Chunk[W] to the output of this Pull.

    Write a Chunk[W] to the output of this Pull.

    Definition Classes
    PullDerived
  52. def output1[F[_], W](w: W): Pull[F, W, Unit]

    Permalink

    Write a single W to the output of this Pull.

    Write a single W to the output of this Pull.

    Definition Classes
    PullDerived
  53. def outputs[F[_], O](s: Stream[F, O]): Pull[F, O, Unit]

    Permalink

    Write a stream to the output of this Pull.

    Write a stream to the output of this Pull.

    Definition Classes
    PullPulls
  54. def prefetch[F[_], I](h: Handle[F, I])(implicit arg0: Async[F]): Pull[F, Nothing, Pull[F, Nothing, Handle[F, I]]]

    Permalink

    Like await, but runs the await asynchronously.

    Like await, but runs the await asynchronously. A flatMap into inner Pull logically blocks until this await completes.

    Definition Classes
    pull1
  55. def pure[R](r: R): Pull[Nothing, Nothing, R]

    Permalink

    The Pull that reads and outputs nothing, and succeeds with the given value, R.

    The Pull that reads and outputs nothing, and succeeds with the given value, R.

    Definition Classes
    PullPulls
  56. def receive[F[_], I, O, R](f: (Step[Chunk[I], Handle[F, I]]) ⇒ Pull[F, O, R]): (Handle[F, I]) ⇒ Pull[F, O, R]

    Permalink

    Apply f to the next available Chunk.

    Apply f to the next available Chunk.

    Definition Classes
    pull1
  57. def receive1[F[_], I, O, R](f: (Step[I, Handle[F, I]]) ⇒ Pull[F, O, R]): (Handle[F, I]) ⇒ Pull[F, O, R]

    Permalink

    Apply f to the next available element.

    Apply f to the next available element.

    Definition Classes
    pull1
  58. def receive1Option[F[_], I, O, R](f: (Option[Step[I, Handle[F, I]]]) ⇒ Pull[F, O, R]): (Handle[F, I]) ⇒ Pull[F, O, R]

    Permalink

    Apply f to the next available element, or None if the input is exhausted.

    Apply f to the next available element, or None if the input is exhausted.

    Definition Classes
    pull1
  59. def receiveNonemptyOption[F[_], I, O, R](f: (Option[Step[Chunk[I], Handle[F, I]]]) ⇒ Pull[F, O, R]): (Handle[F, I]) ⇒ Pull[F, O, R]

    Permalink
    Definition Classes
    pull1
  60. def receiveOption[F[_], I, O, R](f: (Option[Step[Chunk[I], Handle[F, I]]]) ⇒ Pull[F, O, R]): (Handle[F, I]) ⇒ Pull[F, O, R]

    Permalink

    Apply f to the next available chunk, or None if the input is exhausted.

    Apply f to the next available chunk, or None if the input is exhausted.

    Definition Classes
    pull1
  61. def suspend[F[_], O, R](p: ⇒ Pull[F, O, R]): Pull[F, O, R]

    Permalink
    Definition Classes
    PullDerived
  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  63. def take[F[_], I](n: Long)(h: Handle[F, I]): Pull[F, I, Handle[F, I]]

    Permalink

    Emit the first n elements of the input Handle and return the new Handle.

    Emit the first n elements of the input Handle and return the new Handle.

    Definition Classes
    pull1
  64. def takeRight[F[_], I](n: Long)(h: Handle[F, I]): Pull[F, Nothing, Vector[I]]

    Permalink

    Emits the last n elements of the input.

    Emits the last n elements of the input.

    Definition Classes
    pull1
  65. def takeThrough[F[_], I](p: (I) ⇒ Boolean): (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Like takeWhile, but emits the first value which tests false.

    Like takeWhile, but emits the first value which tests false.

    Definition Classes
    pull1
  66. def takeWhile[F[_], I](p: (I) ⇒ Boolean): (Handle[F, I]) ⇒ Pull[F, I, Handle[F, I]]

    Permalink

    Emit the elements of the input Handle until the predicate p fails, and return the new Handle.

    Emit the elements of the input Handle until the predicate p fails, and return the new Handle. If nonempty, the returned Handle will have a first element i for which p(i) is false.

    Definition Classes
    pull1
  67. def toString(): String

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

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

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

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

Inherited from pull1

Inherited from PullDerived

Inherited from Pulls[Pull]

Inherited from AnyRef

Inherited from Any

Ungrouped