monads-tf- Monad classes, using type familiesSource codeContentsIndex
Portabilitynon-portable (type families)

MonadState class.

This module is inspired by the paper /Functional Programming with Overloading and Higher-Order Polymorphism/, Mark P Jones ( Advanced School of Functional Programming, 1995.

class Monad m => MonadState m where
type StateType m
get :: m (StateType m)
put :: StateType m -> m ()
modify :: MonadState m => (StateType m -> StateType m) -> m ()
gets :: MonadState m => (StateType m -> a) -> m a
class Monad m => MonadState m whereSource

get returns the state from the internals of the monad.

put replaces the state inside the monad.

Associated Types
type StateType m Source
get :: m (StateType m)Source
put :: StateType m -> m ()Source
show/hide Instances
modify :: MonadState m => (StateType m -> StateType m) -> m ()Source

Monadic state transformer.

Maps an old state to a new state inside a state monad. The old state is thrown away.

      Main> :t modify ((+1) :: Int -> Int)
      modify (...) :: (MonadState Int a) => a ()

This says that modify (+1) acts over any Monad that is a member of the MonadState class, with an Int state.

gets :: MonadState m => (StateType m -> a) -> m aSource
Gets specific component of the state, using a projection function supplied.
Produced by Haddock version 2.6.0