beam-core
API
Generated with
beam-core/beam/PipeEffect

PipeEffect

beam.PipeEffect
trait PipeEffect[I, O] extends PipeEffectExt[I, O, Unit]

Attributes

Graph
Supertypes
trait PipeEffectExt[I, O, Unit]
trait PipeSignature[I, O, Unit]
trait Signature
trait Effect[PipeSignature[I, O, Unit]]
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] = PipeSignature[I, O, Unit] & Signature { type ThisEffect = U; }

API for defining custom effects.

API for defining custom effects.

Attributes

Inherited from:
Effect

Value members

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 override def accept: Computation[Option[I], PipeEffectExt.this.type]

Attributes

Definition Classes
Inherited from:
PipeEffectExt
final def acceptOrElse[A >: I, U <: PipeEffect[I, O]](value: => A): Computation[A, U]

Attributes

Inherited from:
PipeEffectExt
final def acceptOrElseEff[A >: I, U <: PipeEffect[I, O]](comp: => Computation[A, U]): Computation[A, U]

Attributes

Inherited from:
PipeEffectExt
final def acceptOrElseExit(value: => Unit): Computation[I, PipeEffectExt.this.type]

Attributes

Inherited from:
PipeEffectExt
final def defaultHandler[U](Fx: SourceEffect[O], input: Stream[I, U]): Handler[Const[Unit], Const[Unit], PipeEffectExt.this.type, U & Fx.type]

Attributes

Inherited from:
PipeEffectExt
final override def emit(value: O): Computation[Unit, PipeEffectExt.this.type]

Attributes

Definition Classes
Inherited from:
PipeEffectExt
final def emit1[O2](value: O2)(using ev: Chunk[O2] <:< O): Computation[Unit, PipeEffectExt.this.type]

Attributes

Inherited from:
PipeEffectExt
final def emitIfNonEmpty[O2](values: Chunk[O2])(using ev: Chunk[O2] <:< O): Computation[Unit, PipeEffectExt.this.type]

Attributes

Inherited from:
PipeEffectExt
final def emitOpt(value: Option[O]): Computation[Unit, PipeEffectExt.this.type]

Attributes

Inherited from:
PipeEffectExt
final def exit(using ev: Unit =:= Unit): Computation[Nothing, ThisEffect]

Attributes

Inherited from:
PipeEffectExt
final override def exit(value: Unit): Computation[Nothing, PipeEffectExt.this.type]

Attributes

Definition Classes
Inherited from:
PipeEffectExt
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[PipeEffect[I, O]]

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