Polysemy.AtomicState

Effect

data AtomicState s m a where

A variant of State that supports atomic operations.

Since: 1.1.0.0

Constructors

AtomicState :: (s -> (s, a)) -> AtomicState s m a

Run a state action.

AtomicGet :: AtomicState s m s

Get the state.

Actions

atomicState :: forall s a r. Member (AtomicState s) r => (s -> (s, a)) -> Sem r a

Run a state action.

atomicState' :: forall s a r. Member (AtomicState s) r => (s -> (s, a)) -> Sem r a

A variant of atomicState in which the computation is strict in the new state and return value.

atomicGet :: forall s r. Member (AtomicState s) r => Sem r s

Get the state.

atomicGets :: forall s s' r. Member (AtomicState s) r => (s -> s') -> Sem r s'

Since: 1.2.2.0

atomicPut :: Member (AtomicState s) r => s -> Sem r ()

Replace the state with the given value.

atomicModify :: Member (AtomicState s) r => (s -> s) -> Sem r ()

Modify the state lazily.

atomicModify' :: Member (AtomicState s) r => (s -> s) -> Sem r ()

A variant of atomicModify in which the computation is strict in the new state.

Interpretations

runAtomicStateIORef :: forall s r a. Member (Embed IO) r => IORef s -> Sem (AtomicState s ': r) a -> Sem r a

Run an AtomicState effect by transforming it into atomic operations over an IORef.

runAtomicStateTVar :: Member (Embed IO) r => TVar s -> Sem (AtomicState s ': r) a -> Sem r a

Run an AtomicState effect by transforming it into atomic operations over a TVar.

atomicStateToIO :: forall s r a. Member (Embed IO) r => s -> Sem (AtomicState s ': r) a -> Sem r (s, a)

Run an AtomicState effect in terms of atomic operations in IO.

Internally, this simply creates a new IORef, passes it to runAtomicStateIORef, and then returns the result and the final value of the IORef.

Beware: As this uses an IORef internally, all other effects will have local state semantics in regards to AtomicState effects interpreted this way. For example, throw and catch will never revert atomicModifys, even if runError is used after atomicStateToIO.

Since: 1.2.0.0

atomicStateToState :: Member (State s) r => Sem (AtomicState s ': r) a -> Sem r a

Transform an AtomicState effect to a State effect, discarding the notion of atomicity.

runAtomicStateViaState :: s -> Sem (AtomicState s ': r) a -> Sem r (s, a)

Run an AtomicState with local state semantics, discarding the notion of atomicity, by transforming it into State and running it with the provided initial state.

@since v1.7.0.0

evalAtomicStateViaState :: s -> Sem (AtomicState s ': r) a -> Sem r a

Evaluate an AtomicState with local state semantics, discarding the notion of atomicity, by transforming it into State and running it with the provided initial state.

@since v1.7.0.0

execAtomicStateViaState :: s -> Sem (AtomicState s ': r) a -> Sem r s

Execute an AtomicState with local state semantics, discarding the notion of atomicity, by transforming it into State and running it with the provided initial state.

@since v1.7.0.0