Pulls

Laws:

or forms a monoid in conjunction with done:

or(done, p) == p and or(p, done) == p. or(or(p1,p2), p3) == or(p1, or(p2,p3))

fail is caught by onError:

onError(fail(e))(f) == f(e)

Pull forms a monad 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

Source: Pulls.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

Pull

Type Members

abstract type Stream[+F[_], +O]

Abstract Value Members

abstract def close[F[_], O, R](p: Pull[F, O, R]): Stream[F, O]

Interpret this Pull to produce a Stream.
Interpret this Pull to produce a Stream. The result type R is discarded.
abstract def done: Pull[Nothing, Nothing, Nothing]

The completed Pull.
The completed Pull. Reads and outputs nothing.
abstract def eval[F[_], R](f: F[R]): Pull[F, Nothing, R]

Promote an effect to a Pull.
abstract def fail(err: Throwable): Pull[Nothing, Nothing, Nothing]

The Pull that reads and outputs nothing, and fails with the given error.
abstract def flatMap[F[_], O, R0, R](p: Pull[F, O, R0])(f: (R0) ⇒ Pull[F, O, R]): Pull[F, O, R]

Monadic bind.
abstract def onError[F[_], O, R](p: Pull[F, O, R])(handle: (Throwable) ⇒ Pull[F, O, R]): Pull[F, O, R]

If p terminates with fail(e), invoke handle(e).
abstract def or[F[_], O, R](p1: Pull[F, O, R], p2: ⇒ Pull[F, O, R]): Pull[F, O, R]

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.
abstract def outputs[F[_], O](s: Stream[F, O]): Pull[F, O, Unit]

Write a stream to the output of this Pull.
abstract def pure[R](a: R): Pull[Nothing, Nothing, R]

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

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Pulls[Pull]) ⇒ Boolean, msg: ⇒ Any): Pulls[Pull]

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

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

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

Implicit information
This member is added by an implicit conversion from Pulls[Pull] to Ensuring[Pulls[Pull]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Pulls[Pull], B)

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

Related Doc: package fs2

trait Pulls[Pull[+_[_], +_, +_]] extends AnyRef

Type Members

abstract type Stream[+F[_], +O]

Abstract Value Members

abstract def close[F[_], O, R](p: Pull[F, O, R]): Stream[F, O]

abstract def done: Pull[Nothing, Nothing, Nothing]

abstract def eval[F[_], R](f: F[R]): Pull[F, Nothing, R]

abstract def fail(err: Throwable): Pull[Nothing, Nothing, Nothing]

abstract def flatMap[F[_], O, R0, R](p: Pull[F, O, R0])(f: (R0) ⇒ Pull[F, O, R]): Pull[F, O, R]

abstract def onError[F[_], O, R](p: Pull[F, O, R])(handle: (Throwable) ⇒ Pull[F, O, R]): Pull[F, O, R]

abstract def or[F[_], O, R](p1: Pull[F, O, R], p2: ⇒ Pull[F, O, R]): Pull[F, O, R]

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

abstract def pure[R](a: R): Pull[Nothing, Nothing, R]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Pulls[Pull], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Pulls[Pull]) ⇒ Boolean, msg: ⇒ Any): Pulls[Pull]

def ensuring(cond: (Pulls[Pull]) ⇒ Boolean): Pulls[Pull]

def ensuring(cond: Boolean, msg: ⇒ Any): Pulls[Pull]

def ensuring(cond: Boolean): Pulls[Pull]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Pulls[Pull], B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Pulls[Pull] to any2stringadd[Pulls[Pull]]

Inherited by implicit conversion StringFormat from Pulls[Pull] to StringFormat[Pulls[Pull]]

Inherited by implicit conversion Ensuring from Pulls[Pull] to Ensuring[Pulls[Pull]]

Inherited by implicit conversion ArrowAssoc from Pulls[Pull] to ArrowAssoc[Pulls[Pull]]

Ungrouped