Effect

turbolift.Effect
See theEffect companion object
trait Effect[Z <: Signature] extends CanPerform[Z] with CanInterpret

Base trait for any user-defined effect.

Instances of Effect are used for:

  • Establishing unique identity of the effect.
  • Invoking operations of the effect.

Example:

import turbolift.{!!, Signature, Effect}}

trait GoogleSignature extends Signature:
 def countPicturesOf(topic: String): Int !@! ThisEffect

// Boilerplate:
trait Google extends Effect[GoogleSignature] with GoogleSignature:
 final override def countPicturesOf(topic: String): Int !! this.type = perform(_.countPicturesOf(topic))

// Instantiaton establishes the identity:
case object MyGoogle extends Google
type MyGoogle = MyGoogle.type

// Invoking operations:
val program: Int !! MyGoogle = MyGoogle.countPicturesOf("cat")

For details, see Defining your own effects and handlers.

Attributes

Z

The Signature of this effect.

Companion:
object
Graph
Supertypes
trait CanPerform[Z]
trait Signature
class Object
trait Matchable
class Any
Known subtypes
trait Choice
object Each.type
object Fail.type
object Console.type
trait ErrorEffect[E, E1]
trait Error[E]
trait ErrorK[F, E]
object Random.type
trait Reader[R]
trait State[S]
trait WriterEffect[W, W1]
trait Writer[W]
trait WriterG[M, K, V]
trait WriterGK[M, K, F, V]
trait WriterK[F, W]
Self type

Members list

Concise view

Type members

Inherited classlikes

abstract class Proxy[Fx] extends Proxy[Fx] with ThisInterpreter

Base class for any user-defined proxy interpreter for this effect.

Base class for any user-defined proxy interpreter for this effect.

Like Proxy Interpreter, but specialized for this effect.

Attributes

Inherited from:
CanInterpret
Graph
Supertypes
trait Proxy[Fx]
trait Signature
class Object
trait Matchable
class Any
abstract class Stateful[S, F[_]] extends Stateful[S, F] with ThisInterpreter

Base class for any user-defined stateful interpreter for this effect.

Base class for any user-defined stateful interpreter for this effect.

Like Stateful Interpreter, but specialized for this effect.

Attributes

Inherited from:
CanInterpret
Graph
Supertypes
class Stateful[S, F]
class Flow
trait Signature
class Object
trait Matchable
class Any
abstract class Stateless[F[_]] extends Stateless[F] with ThisInterpreter

Base class for any user-defined stateless interpreter for this effect.

Base class for any user-defined stateless interpreter for this effect.

Like Stateless Interpreter, but specialized for this effect.

Attributes

Inherited from:
CanInterpret
Graph
Supertypes
class Stateless[F]
class Flow
trait Signature
class Object
trait Matchable
class Any

Defines type aliases for Handler, specialized to eliminate this effect.

Defines type aliases for Handler, specialized to eliminate this effect.

Attributes

Inherited from:
CanInterpret
Graph
Supertypes
class Object
trait Matchable
class Any
sealed trait ThisInterpreter

Attributes

Inherited from:
CanInterpret
Graph
Supertypes
trait Signature
class Object
trait Matchable
class Any
Known subtypes
class Proxy[Fx]
class Stateful[S, F]
class Stateless[F]

Types

final override type ThisEffect = Effect.this.type

Abstract type that must be used in definitions of effect's operations.

Abstract type that must be used in definitions of effect's operations.

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

Attributes

Inherited types

final override type !@![+A, U] = Computation[A, U]

Abstract type that must be used in definitions of effect's operations.

Abstract type that must be used in definitions of effect's operations.

Becomes an alias of Computation (i.e. same as !!), once the signature is inherited from Effect.

Attributes

Inherited from:
CanPerform
final type ThisHandler[F[_], N] = Handler[F, ThisEffect, N]

Alias for Handler, specialized to eliminate this effect.

Alias for Handler, specialized to eliminate this effect.

Attributes

Inherited from:
CanInterpret

Value members

Concrete methods

final def &![Fx2 <: HasSignature](fx2: Fx2): Combine2[Effect, Fx2]

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 methods

final def perform[A, U <: ThisEffect](f: (z: Z & Signature { type ThisEffect = U; }) => 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
final def pure[A](a: A): Computation[A, ThisEffect]

Like !!.pure(a), but with effect-set up-casted to ThisEffect

Like !!.pure(a), but with effect-set up-casted to ThisEffect

Attributes

Inherited from:
CanPerform

Exports

Inherited defined exports

final type Parallel = Parallel
Exported from Features$

Attributes

Inherited from:
CanInterpret
final val Parallel: Parallel.type
Exported from Features

Attributes

Inherited from:
CanInterpret
final type Sequential = Sequential
Exported from Features$

Attributes

Inherited from:
CanInterpret