turbolift-core
API
Generated with
turbolift-core/turbolift/turbolift.effects/WriterEffectExt

WriterEffectExt

turbolift.effects.WriterEffectExt
See theWriterEffectExt companion object
trait WriterEffectExt[W, W1] extends Effect[WriterSignature[W, W1]], WriterSignature[W, W1]

Base trait for custom instances of Writer effect.

case object MyWriter extends WriterEffect[Int]
// optional:
type MyWriter = MyWriter.type

Notice that WriterEffectExt takes type 2 parameters. This abstraction enables ergonomic syntax of tell(w), which relieves the user from the necessity of wrapping w in Nel (raise(Nel(w))), as in the standard Writer monad. For the simpler, single-parmeter version, see WriterEffect.

Type parameters

W

Accumulator

W1

Singular value added to the accumulator

Attributes

See also
Companion
object
Graph
Supertypes
trait WriterSignature[W, W1]
trait Signature
trait Effect[WriterSignature[W, W1]]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait WriterEffect[W]
trait WriterEffectG[M, K, V]
trait WriterEffectGK[M, K, F, V]
trait WriterEffectK[F, W]
Self type

Members list

Type members

Classlikes

object handlers

Predefined handlers for this effect.

Predefined handlers for this effect.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
handlers.type

Inherited types

final override type ThisEffect = Effect.this.type

Attributes

Inherited from:
Effect
type ThisSignature[U] = WriterSignature[W, W1] & 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 censor[A, U <: WriterEffectExt[W, W1]](f: W => W)(body: Computation[A, U]): Computation[A, U]

Attributes

Definition Classes
def handler(using W: AccumZero[W, W1]): Handler[Identity, Tuple2, thiz.type, Any]
Extension method from WriterEffectExt

Alias of the default handler for this effect.

Alias of the default handler for this effect.

Defined as an extension, to allow custom redefinitions without restrictions imposed by overriding

Attributes

final override def listen[A, U <: WriterEffectExt[W, W1]](body: Computation[A, U]): Computation[(A, W), U]

Attributes

Definition Classes
final override def mute[A, U <: WriterEffectExt[W, W1]](body: Computation[A, U]): Computation[A, U]

Attributes

Definition Classes
final override def pass[A, U <: WriterEffectExt[W, W1]](body: Computation[(A, W => W), U]): Computation[A, U]

Attributes

Definition Classes
final override def tell(w: W1): Computation[Unit, this.type]

Attributes

Definition Classes
final def tell[K, V1](k: K, v: V1)(using ev: (K, V1) <:< W1): Computation[Unit, this.type]
final override def tells(w: W): Computation[Unit, this.type]

Attributes

Definition Classes

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[WriterEffectExt[W, W1]]

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