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

CoroutineEffect

turbolift.effects.CoroutineEffect
See theCoroutineEffect companion object
trait CoroutineEffect[I, O, R] extends Effect[CoroutineSignature[I, O, R]], CoroutineSignature[I, O, R]

Base trait for custom instances of Coroutine effect.

case object MyCoroutine extends CoroutineEffect[Int, String, Unit]
// optional:
type MyCoroutine = MyCoroutine.type

Type parameters

I

value passed to the coroutine when it's resumed

O

value returned by the coroutine when it suspends

R

value returned by the coroutine when it ends

Attributes

See also
Companion
object
Graph
Supertypes
trait CoroutineSignature[I, O, R]
trait Signature
trait Effect[CoroutineSignature[I, O, R]]
class Object
trait Matchable
class Any
Show all
Self type
CoroutineEffect[I, O, R]

Members list

Type members

Inherited types

final override type ThisEffect = Effect.this.type

Attributes

Inherited from:
Effect
type ThisSignature[U] = CoroutineSignature[I, O, 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 exit(value: R): Computation[Nothing, this.type]

Attributes

Definition Classes
final def handler[U]: Handler[Const[R], Const[Step[I, O, R, U & CoroutineEffect.this.type]], this.type, Any]
final override def yeld(value: O): Computation[I, 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[CoroutineEffect[I, O, 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 type ThisHandler = [F[_], G[_], N] =>> this.impl.ThisHandler[F, G, N]
Exported from Impl

Attributes

Inherited from:
Effect
Generated with