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

Type Members

  1. sealed abstract class Cancellable[+F[_], +R] extends AnyRef

    Permalink

    Result of acquireCancellable.

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 Cancellable

    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 .stream scope which executes the returned Pull. The acquired resource is returned as the result value of the pull.

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

    Permalink

    Like acquire but the result value consists of a cancellation pull and the acquired resource.

    Like acquire but the result value consists 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.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def attemptEval[F[_], R](fr: F[R]): Pull[F, Nothing, Either[Throwable, R]]

    Permalink

    Like eval but if the effectful value fails, the exception is returned in a Left instead of failing the pull.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. implicit def covaryPure[F[_], O, R, O2 >: O, R2 >: R](p: Pull[Pure, O, R]): Pull[F, O2, R2]

    Permalink

    Implicitly covaries a pull.

  11. val done: Pull[Nothing, Nothing, Unit]

    Permalink

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

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

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

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

    Permalink

    Evaluates the supplied effectful value and returns the result as the resource of the returned pull.

  15. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Any
  19. def loop[F[_], O, R](using: (R) ⇒ Pull[F, O, Option[R]]): (R) ⇒ Pull[F, O, Option[R]]

    Permalink

    Repeatedly uses the output of the pull as input for the next step of the pull.

    Repeatedly uses the output of the pull as input for the next step of the pull. Halts when a step terminates with None or Pull.raiseError.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. def output[F[_], O](os: Segment[O, Unit]): Pull[F, O, Unit]

    Permalink

    Ouptuts a segment of values.

  24. def output1[F[_], O](o: O): Pull[F, O, Unit]

    Permalink

    Ouptuts a single value.

  25. def outputChunk[F[_], O](os: Chunk[O]): Pull[F, O, Unit]

    Permalink

    Ouptuts a chunk of values.

  26. def pure[F[_], R](r: R): Pull[F, Nothing, R]

    Permalink

    Pull that outputs nothing and has result of r.

  27. def raiseError(err: Throwable): Pull[Nothing, Nothing, Nothing]

    Permalink

    Reads and outputs nothing, and fails with the given error.

  28. def segment[F[_], O, R](s: Segment[O, R]): Pull[F, O, R]

    Permalink

    Pull that outputs the specified segment and returns the result of the segment as the result of the pull.

    Pull that outputs the specified segment and returns the result of the segment as the result of the pull. Less efficient than output.

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

    Permalink

    Returns a pull that evaluates the supplied by-name each time the pull is used, allowing use of a mutable value in pull computations.

  30. implicit def syncInstance[F[_], O]: Sync[[γ$6$]Pull[F, O, γ$6$]]

    Permalink

    Sync instance for Stream.

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped