Effectful.State.Static.Shared

Support for access to a shared, mutable value of a particular type.

The value is shared between multiple threads. If you want each thead to manage its own version of the value, use Effectful.State.Static.Local.

Note: unlike the StateT monad transformer from the transformers library, the State effect doesn't discard state updates when an exception is received:

>>> import Control.Exception (ErrorCall)
>>> import Control.Monad.Catch
>>> import Control.Monad.Trans.State.Strict qualified as S

>>> :{
  (`S.execStateT` "Hi") . handle (\(_::ErrorCall) -> pure ()) $ do
    S.modify (++ " there!")
    error "oops"
:}
"Hi"

>>> :{
  runEff . execState "Hi" . handle (\(_::ErrorCall) -> pure ()) $ do
    modify (++ " there!")
    error "oops"
:}
"Hi there!"

Effect

data State (s :: Type) :: Effect

Provide access to a strict (WHNF), shared, mutable value of type s.

Instances

type DispatchOf (State s)

Defined in Effectful.State.Static.Shared

type DispatchOf (State s) = 'Static 'NoSideEffects

newtype StaticRep (State s)

Defined in Effectful.State.Static.Shared

newtype StaticRep (State s) = State (MVar' s)

Handlers

runState :: HasCallStack => s -> Eff (State s : es) a -> Eff es (a, s)

Run the State effect with the given initial state and return the final value along with the final state.

evalState :: HasCallStack => s -> Eff (State s : es) a -> Eff es a

Run the State effect with the given initial state and return the final value, discarding the final state.

execState :: HasCallStack => s -> Eff (State s : es) a -> Eff es s

Run the State effect with the given initial state and return the final state, discarding the final value.

runStateMVar :: HasCallStack => MVar' s -> Eff (State s : es) a -> Eff es (a, s)

Run the State effect with the given initial state MVar' and return the final value along with the final state.

evalStateMVar :: HasCallStack => MVar' s -> Eff (State s : es) a -> Eff es a

Run the State effect with the given initial state MVar' and return the final value, discarding the final state.

execStateMVar :: HasCallStack => MVar' s -> Eff (State s : es) a -> Eff es s

Run the State effect with the given initial state MVar' and return the final state, discarding the final value.

Operations

get :: (HasCallStack, State s :> es) => Eff es s

Fetch the current value of the state.

gets :: (HasCallStack, State s :> es) => (s -> a) -> Eff es a

Get a function of the current state.

gets f ≡ f <$> get

put :: (HasCallStack, State s :> es) => s -> Eff es ()

Set the current state to the given value.

state :: (HasCallStack, State s :> es) => (s -> (a, s)) -> Eff es a

Apply the function to the current state and return a value.

Note: this function gets an exclusive access to the state for its duration.

modify :: (HasCallStack, State s :> es) => (s -> s) -> Eff es ()

Apply the function to the current state.

modify f ≡ state (\s -> ((), f s))

Note: this function gets an exclusive access to the state for its duration.

stateM :: (HasCallStack, State s :> es) => (s -> Eff es (a, s)) -> Eff es a

Apply the monadic function to the current state and return a value.

Note: this function gets an exclusive access to the state for its duration.

modifyM :: (HasCallStack, State s :> es) => (s -> Eff es s) -> Eff es ()

Apply the monadic function to the current state.

modifyM f ≡ stateM (\s -> ((), ) <$> f s)

Note: this function gets an exclusive access to the state for its duration.