Moduleeffectful-core-2.3.0.1Haskell2010

Effectful.State.Dynamic

The dynamically dispatched variant of the State effect.

Note: unless you plan to change interpretations at runtime, it's recommended to use one of the statically dispatched variants, i.e. Effectful.State.Static.Local or Effectful.State.Static.Shared.

Effect

1 declaration

datadata State s (a :: Type -> Type) b where

Provide access to a mutable value of type s.

Instances1DispatchOf

type DispatchOf (State s) = 'DynamicDefined in effectful-core-2.3.0.1 · Effectful.State.Dynamic

valuerunStateLocal :: 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 (via Effectful.State.Static.Local).

valueevalStateLocal :: 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 (via Effectful.State.Static.Local).

valueexecStateLocal :: 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 (via Effectful.State.Static.Local).

valuerunStateShared :: 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 (via Effectful.State.Static.Shared).

valueevalStateShared :: 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 (via Effectful.State.Static.Shared).

valueexecStateShared :: 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 (via Effectful.State.Static.Shared).

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

Fetch the current value of the state.

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

Get a function of the current state.

gets f ≡ f <$> get

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

Set the current state to the given value.

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

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

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

Apply the function to the current state.

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

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

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

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

Apply the monadic function to the current state.

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