beam-core
API
Generated with
beam-core/beam/SourceEffectExt/Stateful

Stateful

beam.SourceEffectExt.Stateful
abstract class Stateful[S, U](initial: S) extends StatefulReturn[S, Unit, U]

Attributes

Graph
Supertypes
class StatefulReturn[S, Unit, U]
trait SourceSignature[O, Unit]
trait Sequential
trait Default
class impl.Stateful[Const[Unit], Const[Unit], U]
trait impl.ThisInterpreter
class Stateful[Const[Unit], Const[Unit], U]
trait Interpreter
trait Signature
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

final override type Elim = EffectImpl.this.Fx

Set of effects eliminated from computation by this interpreter.

Set of effects eliminated from computation by this interpreter.

Attributes

Inherited from:
ThisInterpreter
final override type From[+A] = Const[Unit][A]

Input of this interpreter.

Input of this interpreter.

Attributes

Inherited from:
Stateful
final override type Intro = U

Set of effects introduced into computation by this interpreter (a.k.a. dependencies).

Set of effects introduced into computation by this interpreter (a.k.a. dependencies).

Attributes

Inherited from:
Stateful
final override type Local = S

Local state of this interpreter.

Local state of this interpreter.

Attributes

Inherited from:
StatefulReturn
final type ThisEffect = Intro & Ambient

Self-reference to the effect being described by this Signature.

Self-reference to the effect being described by this Signature.

Becomes an alias of this.type, once the signature is inherited from Effect.

Attributes

Inherited from:
Interpreter
final override type To[+A] = Const[Unit][A]

Output of this interpreter.

Output of this interpreter.

Attributes

Inherited from:
Stateful

Inherited and Abstract types

type Ambient

Phantom type, representing universally quantified type of the corresponding handler.

Phantom type, representing universally quantified type of the corresponding handler.

A Handler acts as a higher-rank function of type:

[A, U] => (From[A] !! (Elim & U)) => To[A] !! (Intro & U)

The Ambient type of this interpreter corresponds to the U type parameter above. See also Unknown.

Attributes

Inherited from:
Interpreter
type Unknown

Phantom type, representing universally quantified type of the corresponding handler.

Phantom type, representing universally quantified type of the corresponding handler.

A Handler acts as a higher-rank function of type:

[A, U] => (From[A] !! (Elim & U)) => To[A] !! (Intro & U)

The Unknown type of this interpreter corresponds to the A type parameter above. See also Ambient.

Attributes

Inherited from:
Interpreter

Value members

Concrete methods

override def onReturn(s: Local): Computation[Unit, ThisEffect]

Attributes

Definition Classes

Inherited methods

def captureHint: Boolean

Microoptimization hint, stating intent to use continuations.

Microoptimization hint, stating intent to use continuations.

Many effect handlers never capture the continuation, and this is the default expectation.

The capture will work regardless of value of this hint. However, if not overriden to true, the first capture will be more costly.

Attributes

Inherited from:
Interpreter
override def exit(r: Unit): Computation[Nothing, ThisEffect]

Attributes

Definition Classes
Inherited from:
StatefulReturn
final inline def hasForkJoin: Boolean

Attributes

Inherited from:
Interpreter
final inline def hasRestart: Boolean

Attributes

Inherited from:
Interpreter
final inline def hasZip: Boolean

Attributes

Inherited from:
Interpreter
final inline def isIo: Boolean

Attributes

Inherited from:
Interpreter
final inline def isParallel: Boolean

Attributes

Inherited from:
Interpreter
final inline def isStateful: Boolean

Attributes

Inherited from:
Interpreter
final inline def isStateless: Boolean

Attributes

Inherited from:
Interpreter
final inline def localCount: Int

Attributes

Inherited from:
Interpreter
final override def onFork(s: Local): (Local, Local)

Attributes

Definition Classes
HasNotForkJoin -> Interpreter
Inherited from:
HasNotForkJoin (hidden)
override def onInitial: Computation[Local, Intro]

Attributes

Definition Classes
StatefulReturn -> Interpreter
Inherited from:
StatefulReturn
final override def onJoin(s1: Local, s2: Local): Local

Attributes

Definition Classes
HasNotForkJoin -> Interpreter
Inherited from:
HasNotForkJoin (hidden)
final override def onRestart(aa: Const[Unit][Unknown]): Computation[Unknown, Elim]

Attributes

Definition Classes
HasNotRestart -> Interpreter
Inherited from:
HasNotRestart (hidden)
override def onReturn(x: Unit, s: Local): Computation[Const[Unit][Unknown], ThisEffect]

Attributes

Definition Classes
StatefulReturn -> Interpreter
Inherited from:
StatefulReturn
final override def onUnknown(aa: Const[Unit][Unknown]): Option[Unknown]

Attributes

Definition Classes
HasNotRestart -> Interpreter
Inherited from:
HasNotRestart (hidden)
final override def onZip[A, B, C](aa: Const[Unit][A], bb: Const[Unit][B], k: (A, B) => C): To[C]

Attributes

Definition Classes
HasNotZip -> Interpreter
Inherited from:
HasNotZip (hidden)
final inline def prompt: Prompt

Attributes

Inherited from:
Interpreter
final def toHandler: Handler[From, To, Elim, Intro]

Creates a Handler from this interpreter.

Creates a Handler from this interpreter.

Attributes

Inherited from:
Interpreter
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Interpreter -> Any
Inherited from:
Interpreter

Inherited and Abstract methods

def emit(value: O): Computation[Unit, ThisEffect]

Attributes

Inherited from:
SourceSignature

Inherited fields

val Control: Control[Local, Unknown, From, To, Elim, Intro, Ambient]

An instance of Control dedicated for this interpreter.

An instance of Control dedicated for this interpreter.

Attributes

Inherited from:
Interpreter
val Local: Local[Local, ThisEffect]

An instance of Local dedicated for this interpreter.

An instance of Local dedicated for this interpreter.

Attributes

Inherited from:
Interpreter
Generated with