turbolift-core/turbolift.std_effects/State

State

trait State[S] extends Effect[StateSig[S]] with StateSig[S]
trait StateSig[S]
trait Effect[StateSig[S]]
trait HasSignature
trait Signature
class Object
trait Matchable
class Any

Type members

Inherited classlikes

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

Base class for user-defined Proxy Interpreter for this effect.

Base class for user-defined Proxy Interpreter for this effect.

Inherited from:
CanInterpret
abstract class Stateful[S, F[_]] extends Stateful[S, F] with ThisInterpreter

Base class for user-defined Stateful Interpreter for this effect.

Base class for user-defined Stateful Interpreter for this effect.

Inherited from:
CanInterpret
abstract class Stateless[F[_]] extends Stateless[F] with ThisInterpreter

Base class for user-defined Stateless Interpreter for this effect.

Base class for user-defined Stateless Interpreter for this effect.

Inherited from:
CanInterpret
object ThisHandler

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

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

Inherited from:
CanInterpret
sealed trait ThisInterpreter extends Unsealed
Inherited from:
CanInterpret

Inherited types

final override type !@![+A, U] = Computation[A, U]
Inherited from:
CanPerform
final override type ThisEffect = Effect
Inherited from:
Effect
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.

Inherited from:
CanInterpret

Value members

Concrete methods

final override def getModify(f: S => S): Computation[S, State[S]]
Definition Classes
final override def getModifyGet(f: S => S): Computation[(S, S), State[S]]
Definition Classes
final override def getUpdate[A](f: S => (A, S)): Computation[(A, S), State[S]]
Definition Classes
final override def getUpdateGet[A](f: S => (A, S)): Computation[(A, S, S), State[S]]
Definition Classes
final override def gets[A](f: S => A): Computation[A, State[S]]
Definition Classes
def handler(initial: S): Free[Tuple2]

Default handler for this effect.

Default handler for this effect.

final override def modify(f: S => S): Computation[Unit, State[S]]
Definition Classes
final override def modifyGet(f: S => S): Computation[S, State[S]]
Definition Classes
final override def put(s: S): Computation[Unit, State[S]]
Definition Classes
final override def swap(s: S): Computation[S, State[S]]
Definition Classes
final override def update[A](f: S => (A, S)): Computation[A, State[S]]
Definition Classes
final override def updateGet[A](f: S => (A, S)): Computation[(A, S), State[S]]
Definition Classes

Inherited methods

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

Combines with another Effect instance, so that a single Handler for 2 effects can be created.

Combines with another Effect instance, so that a single Handler for 2 effects can be created.

Inherited from:
Effect
final def perform[A, U <: ThisEffect](f: StateSig[S] & Signature { type ThisEffect = U; } => A !@! U { def apply(z: StateSig[S] & 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.

The purpose of perform is similar to:

  • send function form various effect systems (Eff monad, etc.)
  • serviceWith from ZIO 1.x.
  • serviceWithZIO from ZIO 2.x.

⚠️ Scaladoc displays the definition of perform as more complex than it actually is:

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

Inherited from:
CanPerform

Concrete fields

final override val get: Computation[S, State[S]]