Data.Effect.State

Effects for holding mutable state values in the context.

Documentation

data State s a where

An effect for holding mutable state values in the context.

Constructors

Get :: forall s. State s s

Retrieves the current state value from the context.

Put :: forall s. s -> State s ()

Overwrites the state value in the context.

type LState s = LiftFOE (State s)

pattern LPut :: forall a s f. () => (a ~ (), ()) => s -> LiftFOE (State s) f a

pattern LGet :: forall a s f. () => (a ~ s, ()) => LiftFOE (State s) f a

get :: SendFOE (State s) f => f s

Retrieves the current state value from the context.

get' :: forall {k} (tag :: k) s f. SendFOE (Tag (State s) tag) f => f s

Retrieves the current state value from the context.

get'' :: forall {k} (key :: k) s f. SendFOEBy key (State s) f => f s

Retrieves the current state value from the context.

put :: SendFOE (State s) f => s -> f ()

Overwrites the state value in the context.

put' :: forall {k} (tag :: k) s f. SendFOE (Tag (State s) tag) f => s -> f ()

Overwrites the state value in the context.

put'' :: forall {k} (key :: k) s f. SendFOEBy key (State s) f => s -> f ()

Overwrites the state value in the context.

gets :: (State s <: f, Functor f) => (s -> a) -> f a

Retrieves the current state value from the context and returns the value transformed based on the given function.

modify :: (State s <: m, Monad m) => (s -> s) -> m ()

Modifies the current state value in the context based on the given function.