Pull

A p: Pull[F,O,R] reads values from one or more streams, returns a result of type R, and produces a Stream[F,O] when calling p.stream.

Any resources acquired by p are freed following the call to stream.

Laws:

Pull forms a monad in R with pure and flatMap:

pure >=> f == f
f >=> pure == f
(f >=> g) >=> h == f >=> (g >=> h) where f >=> g is defined as a => a flatMap f flatMap g

raiseError is caught by handleErrorWith:

handleErrorWith(raiseError(e))(f) == f(e)

Source: Pull.scala

Linear Supertypes

AnyVal, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to any2stringadd[Pull[F, O, R]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Pull[F, O, R], B)

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to ArrowAssoc[Pull[F, O, R]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
Any
def >>[F2[x] >: F[x], O2 >: O, R2](p2: ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

Alias for flatMap(_ => p2).
def as[R2](r2: R2): Pull[F, O, R2]

Alias for _.map(_ => o2).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attempt: Pull[F, O, Either[Throwable, R]]

Returns a pull with the result wrapped in Right, or an error wrapped in Left if the pull has failed.
def covary[F2[x] >: F[x]]: Pull[F2, O, R]

Lifts this pull to the specified effect type.
def covaryAll[F2[x] >: F[x], O2 >: O, R2 >: R]: Pull[F2, O2, R2]

Lifts this pull to the specified effect type, output type, and resource type.
def covaryOutput[O2 >: O]: Pull[F, O2, R]

Lifts this pull to the specified output type.
def covaryResource[R2 >: R]: Pull[F, O, R2]

Lifts this pull to the specified resource type.
def ensuring(cond: (Pull[F, O, R]) ⇒ Boolean, msg: ⇒ Any): Pull[F, O, R]

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to Ensuring[Pull[F, O, R]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Pull[F, O, R]) ⇒ Boolean): Pull[F, O, R]

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to Ensuring[Pull[F, O, R]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Pull[F, O, R]

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to Ensuring[Pull[F, O, R]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Pull[F, O, R]

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to Ensuring[Pull[F, O, R]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def flatMap[F2[x] >: F[x], O2 >: O, R2](f: (R) ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

Applies the resource of this pull to f and returns the result.
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to StringFormat[Pull[F, O, R]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
def handleErrorWith[F2[x] >: F[x], O2 >: O, R2 >: R](h: (Throwable) ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

If this terminates with Pull.raiseError(e), invoke h(e).
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[R2](f: (R) ⇒ R2): Pull[F, O, R2]

Applies the resource of this pull to f and returns the result in a new Pull.
def mapOutput[O2](f: (O) ⇒ O2): Pull[F, O2, R]

Applies the outputs of this pull to f and returns the result in a new Pull.
def onComplete[F2[x] >: F[x], O2 >: O, R2 >: R](p2: ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

Run p2 after this, regardless of errors during this, then reraise any errors encountered during this.
def stream(implicit ev: <:<[R, Unit]): Stream[F, O]

Interpret this Pull to produce a Stream.
Interpret this Pull to produce a Stream.
May only be called on pulls which return a Unit result type. Use p.void.stream to explicitly ignore the result type of the pull.
def toString(): String

Definition Classes
Any
def void: Pull[F, O, Unit]

Discards the result type of this pull.
def →[B](y: B): (Pull[F, O, R], B)

Implicit information
This member is added by an implicit conversion from Pull[F, O, R] to ArrowAssoc[Pull[F, O, R]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object Pull | package fs2

final class Pull[+F[_], +O, +R] extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Pull[F, O, R], B)

final def ==(arg0: Any): Boolean

def >>[F2[x] >: F[x], O2 >: O, R2](p2: ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

def as[R2](r2: R2): Pull[F, O, R2]

final def asInstanceOf[T0]: T0

def attempt: Pull[F, O, Either[Throwable, R]]

def covary[F2[x] >: F[x]]: Pull[F2, O, R]

def covaryAll[F2[x] >: F[x], O2 >: O, R2 >: R]: Pull[F2, O2, R2]

def covaryOutput[O2 >: O]: Pull[F, O2, R]

def covaryResource[R2 >: R]: Pull[F, O, R2]

def ensuring(cond: (Pull[F, O, R]) ⇒ Boolean, msg: ⇒ Any): Pull[F, O, R]

def ensuring(cond: (Pull[F, O, R]) ⇒ Boolean): Pull[F, O, R]

def ensuring(cond: Boolean, msg: ⇒ Any): Pull[F, O, R]

def ensuring(cond: Boolean): Pull[F, O, R]

def flatMap[F2[x] >: F[x], O2 >: O, R2](f: (R) ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

def formatted(fmtstr: String): String

def getClass(): Class[_ <: AnyVal]

def handleErrorWith[F2[x] >: F[x], O2 >: O, R2 >: R](h: (Throwable) ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

final def isInstanceOf[T0]: Boolean

def map[R2](f: (R) ⇒ R2): Pull[F, O, R2]

def mapOutput[O2](f: (O) ⇒ O2): Pull[F, O2, R]

def onComplete[F2[x] >: F[x], O2 >: O, R2 >: R](p2: ⇒ Pull[F2, O2, R2]): Pull[F2, O2, R2]

def stream(implicit ev: <:<[R, Unit]): Stream[F, O]

def toString(): String

def void: Pull[F, O, Unit]

def →[B](y: B): (Pull[F, O, R], B)

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd from Pull[F, O, R] to any2stringadd[Pull[F, O, R]]

Inherited by implicit conversion StringFormat from Pull[F, O, R] to StringFormat[Pull[F, O, R]]

Inherited by implicit conversion Ensuring from Pull[F, O, R] to Ensuring[Pull[F, O, R]]

Inherited by implicit conversion ArrowAssoc from Pull[F, O, R] to ArrowAssoc[Pull[F, O, R]]

Ungrouped