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

SinkEffect

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

Attributes

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

Members list

Type members

Inherited types

final override type ThisEffect = Effect.this.type

Attributes

Inherited from:
Effect
type ThisSignature[U] = SinkSignature[I, R] & Signature { type ThisEffect = U; }

API for defining custom effects.

API for defining custom effects.

Attributes

Inherited from:
Effect

Value members

Concrete methods

final override def accept: Computation[Option[I], this.type]

Attributes

Definition Classes
final def acceptOrElse[A >: I, U <: SinkEffect[I, R]](value: => A): Computation[A, U]
final def acceptOrElseEff[A >: I, U <: SinkEffect[I, R]](comp: => Computation[A, U]): Computation[A, U]
final def acceptOrElseExit(value: => R): Computation[I, this.type]
final def defaultHandler[U](input: Stream[I, U]): Handler[Const[R], Const[R], this.type, U]
final override def exit(value: R): Computation[Nothing, this.type]

Attributes

Definition Classes
final def exit(using ev: Unit =:= R): Computation[Nothing, ThisEffect]

Inherited methods

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

API for defining custom handlers.

API for defining custom handlers.

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

Example of application: implement RWS-alike handler for Reader &! Writer &! State composition of effects.

Attributes

Inherited from:
Effect
final inline def perform[A, U <: ThisEffect](inline f: (ThisSignature[U]) => Computation[A, U]): Computation[A, U]

API for defining custom effects.

API for defining custom effects.

Embeds an invocation of this Signature's method into the Computation monad. This provides mechanism for separation between syntax an semantics of effects.

Attributes

Inherited from:
Effect
final def performNoInline[A, U <: ThisEffect](f: (ThisSignature[U]) => Computation[A, U]): Computation[A, U]

API for defining custom effects.

API for defining custom effects.

Attributes

Inherited from:
Effect

Inherited fields

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

API for defining custom handlers.

API for defining custom handlers.

Helper object providing type definitions to be used for implementing Interpreters for this effect.

Attributes

Inherited from:
Effect

Exports

Inherited defined exports

final val ThisHandler: Impl.this.ThisHandler
Exported from Impl

Attributes

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

Attributes

Inherited from:
Effect
Generated with