Object/Class

fs2

Pull

Related Docs: class Pull | package fs2

Permalink

object Pull

Source
Pull.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pull
  2. AnyRef
  3. 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 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.

  5. 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.

  6. final def asInstanceOf[T0]: T0

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

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. implicit def covaryPure[F[_], W, R](p: Pull[Pure, W, R]): Pull[F, W, R]

    Permalink
  10. def done: Pull[Nothing, Nothing, Nothing]

    Permalink

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

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

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

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

    Permalink

    Promote an effect to a Pull.

  14. def evalScope[F[_], R](f: Scope[F, R]): Pull[F, Nothing, R]

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

    Permalink

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

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  20. 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.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  24. 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).

  25. def output[F[_], W](w: Chunk[W]): Pull[F, W, Unit]

    Permalink

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

  26. def output1[F[_], W](w: W): Pull[F, W, Unit]

    Permalink

    Write a single W to the output of this Pull.

  27. def outputs[F[_], O](s: Stream[F, O]): Pull[F, O, Unit]

    Permalink

    Write a stream to the output of this Pull.

  28. def pure[R](r: R): Pull[Nothing, Nothing, R]

    Permalink

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

  29. def suspend[F[_], O, R](p: ⇒ Pull[F, O, R]): Pull[F, O, R]

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped