Control.Monad.MultiState

Deprecated: Use Control.Monad.Trans.MultiState instead

The multi-valued version of mtl's State / StateT / MonadState

MultiStateT

newtype MultiStateT x m a

A State transformer monad patameterized by:

• x - The list of types constituting the state,
• m - The inner monad.

MultiStateT corresponds to mtl's StateT, but can contain a heterogenous list of types.

This heterogenous list is represented using Types.Data.List, i.e:

• '[] - The empty list,
• a ': b - A list where a is an arbitrary type and b is the rest list.

For example,

MultiStateT '[Int, Bool] :: (* -> *) -> (* -> *)

is a State wrapper containing the types [Int, Bool].

Constructors

MultiStateT

Fields

runMultiStateTRaw :: StateT (HList x) m a

Instances

MonadState s m => MonadState s (MultiStateT c m)

MonadWriter w m => MonadWriter w (MultiStateT c m)

(Monad m, ContainsType a c) => MonadMultiState a (MultiStateT c m)

MonadTrans (MultiStateT x)

Monad m => Monad (MultiStateT x m)

Functor f => Functor (MultiStateT x f)

(Applicative m, Monad m) => Applicative (MultiStateT x m)

type MultiStateTNull = MultiStateT []

A MultiState transformer carrying an empty state.

type MultiState x = MultiStateT x Identity

A state monad parameterized by the list of types x of the state to carry.

Similar to State s = StateT s Identity

MonadMultiState class

class Monad m => MonadMultiState a m where

All methods must be defined.

The idea is: Any monad stack is instance of MonadMultiState a, iff the stack contains a MultiStateT x with a element of x.

Methods

mSet :: a -> m ()

state set function for values of type a.

mGet :: m a

state get function for values of type a.

Instances

(MonadTrans t, Monad (t m), MonadMultiState a m) => MonadMultiState a (t m)

(Monad m, ContainsType a c) => MonadMultiState a (MultiStateT c m)

(Monad m, ContainsType a c) => MonadMultiState a (MultiStateT c m)

(Monad m, ContainsType a s) => MonadMultiState a (MultiRWST r w s m)

(Monad m, ContainsType a s) => MonadMultiState a (MultiRWST r w s m)

run-functions

runMultiStateT :: Functor m => HList s -> MultiStateT s m a -> m (a, HList s)

runMultiStateTAS :: Functor m => HList s -> MultiStateT s m a -> m (a, HList s)

runMultiStateTSA :: Monad m => HList s -> MultiStateT s m a -> m (HList s, a)

runMultiStateTA :: Monad m => HList s -> MultiStateT s m a -> m a

runMultiStateTS :: Monad m => HList s -> MultiStateT s m a -> m (HList s)

runMultiStateT_ :: Functor m => HList s -> MultiStateT s m a -> m ()

runMultiStateTNil :: Monad m => MultiStateT [] m a -> m a

runMultiStateTNil_ :: Functor m => MultiStateT [] m a -> m ()

with-functions (single state)

withMultiState :: Monad m => s -> MultiStateT (s : ss) m a -> MultiStateT ss m (a, s)

withMultiStateAS :: Monad m => s -> MultiStateT (s : ss) m a -> MultiStateT ss m (a, s)

withMultiStateSA :: Monad m => s -> MultiStateT (s : ss) m a -> MultiStateT ss m (s, a)

withMultiStateA :: Monad m => s -> MultiStateT (s : ss) m a -> MultiStateT ss m a

withMultiStateS :: Monad m => s -> MultiStateT (s : ss) m a -> MultiStateT ss m s

withMultiState_ :: (Functor m, Monad m) => s -> MultiStateT (s : ss) m a -> MultiStateT ss m ()

with-functions (multiple states)

withMultiStates :: Monad m => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m (a, HList s1)

withMultiStatesAS :: Monad m => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m (a, HList s1)

withMultiStatesSA :: Monad m => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m (HList s1, a)

withMultiStatesA :: Monad m => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m a

withMultiStatesS :: Monad m => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m (HList s1)

withMultiStates_ :: (Functor m, Monad m) => HList s1 -> MultiStateT (Append s1 s2) m a -> MultiStateT s2 m ()

inflate-functions (run single state in multiple states)

inflateState :: (Monad m, ContainsType s ss) => StateT s m a -> MultiStateT ss m a

inflateReader :: (Monad m, ContainsType r ss) => ReaderT r m a -> MultiStateT ss m a

inflateWriter :: (Monad m, ContainsType w ss, Monoid w) => WriterT w m a -> MultiStateT ss m a

other functions

mapMultiStateT :: (m (a, HList w) -> m' (a', HList w)) -> MultiStateT w m a -> MultiStateT w m' a'

Map both the return value and the state of a computation using the given function.

mGetRaw :: Monad m => MultiStateT a m (HList a)

A raw extractor of the contained HList (i.e. the complete state).

mPutRaw :: Monad m => HList s -> MultiStateT s m ()