beam-core
API
Generated with
beam-core/beam/beam.effects/SinkEffect

SinkEffect

beam.effects.SinkEffect
trait SinkEffect[I, R] extends Effect[SinkSignature[I, R]], SinkSignature[I, R]

Attributes

Graph
Supertypes
trait SinkSignature[I, R]
trait Effect[SinkSignature[I, R]]
trait CanPerform[SinkSignature[I, R]]
trait Signature
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

final override type ThisEffect = Effect.this.type

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:
Effect

Value members

Concrete methods

final override def exit(value: R): Computation[Nothing, this.type]

Attributes

Definition Classes
final def exit(using ev: Unit <:< R): Computation[Nothing, this.type]
final def handler[U](initial: Stream[I, U]): impl.ThisHandler[Const[R], Const[R], U]
final override def read: Computation[I | EndOfInput, this.type]

Attributes

Definition Classes
final def readOrElse[I2 >: I, U <: SinkEffect[I, R]](comp: => Computation[I2, U]): Computation[I2, U]
final def readOrElseExit(r: => R): Computation[I, this.type]
final def readOrElseExit(using Unit <:< R): Computation[I, this.type]
final def tryRead: Computation[Option[I], this.type]

Inherited methods

final def &![Fx2 <: Signature](fx2: Fx2): Combine2[Effect.this.type, fx2.type]

Combines with another Effect instance, for the purpose of sharing an Interpreter.

Combines with another Effect instance, for the purpose of sharing an Interpreter.

Attributes

Inherited from:
Effect
final def perform[A, U <: ThisEffect](f: (SinkSignature[I, R] & Signature { type ThisEffect = U; }) => Computation[A, U]): Computation[A, U]

Lifts an invocation of this Signature's method into the Computation monad.

Lifts an invocation of this Signature's method into the Computation monad.

Attributes

Inherited from:
CanPerform

Inherited fields

val impl: EffectImpl[SinkEffect[I, R]]

Object containing type definitions, to be used for implementing Interpreters for this effect.

Object containing type definitions, to be used for implementing Interpreters for this effect.

Attributes

Inherited from:
Effect

Exports

Inherited defined exports

final type Const = Const
Exported from IdConst$

Attributes

Inherited from:
Effect
final type Identity = Identity
Exported from IdConst$

Attributes

Inherited from:
Effect
final type ThisHandler = [F[_], G[_], N] =>> this.impl.ThisHandler[F, G, N]
Exported from EffectImpl

Attributes

Inherited from:
Effect
Generated with