Control.Monad.Classes

State

type MonadState s m = MonadStateN (Find (EffState s) m) s m

The MonadState s m constraint asserts that m is a monad stack that supports state operations on type s

get :: MonadState a m => m a

Fetch the current value of the state within the monad

put :: MonadState s m => s -> m ()

put s sets the state within the monad to s

modify :: MonadState s m => (s -> s) -> m ()

Maps an old state to a new state inside a state monad layer

modify' :: MonadState s m => (s -> s) -> m ()

A variant of modify in which the computation is strict in the new state

gets :: MonadState s m => (s -> a) -> m a

Gets specific component of the state, using a projection function supplied.

Reader

type MonadReader e m = MonadReaderN (Find (EffReader e) m) e m

The MonadReader r m constraint asserts that m is a monad stack that supports a fixed environment of type r

type MonadLocal e m = MonadLocalN (Find (EffLocal e) m) e m

The MonadLocal r m constraint asserts that m is a monad stack that supports a fixed environment of type r that can be changed externally to the monad

ask :: forall m r. MonadReader r m => m r

Fetch the environment passed through the reader monad

local

Arguments

:: MonadLocal r m

=> (r -> r)

The function to modify the environment.

-> m a

Reader to run in the modified environment.

-> m a

Executes a computation in a modified environment.

Writer

type MonadWriter w m = MonadWriterN (Find (EffWriter w) m) w m

The MonadWriter w m constraint asserts that m is a monad stack that supports outputting values of type w

tell :: forall w m. MonadWriter w m => w -> m ()

tell w is an action that produces the output w

Exceptions

type MonadExcept e m = MonadExceptN (Find (EffExcept e) m) e m

The MonadExcept e m constraint asserts that m is a monad stack that supports throwing exceptions of type e

throw :: forall a e m. MonadExcept e m => e -> m a

Throw an exception

Exec

type MonadExec w m = MonadExecN (Find (EffExec w) m) w m

exec :: forall w m a. MonadExec w m => w a -> m a

Lift an IO action

Core classes and types

Generic lifting

class MonadLiftN n m where

Associated Types

type Down n m :: * -> *

Methods

liftN :: Proxy# n -> Down n m a -> m a

Instances

MonadLiftN Zero m

(MonadLiftN n m, MonadTrans t, Monad m) => MonadLiftN (Succ n) (t m)

Effects

data EffWriter w

Writer effect

data EffReader e

Reader effect

data EffLocal e

Local state change effect

data EffState s

State effect

data EffExec w

Arbitrary monadic effect

Instances

type CanDo * IO (EffExec IO) = True

data EffExcept e

Except effect

Instances

type CanDo * IO (EffExcept e) = True

N-classes

data Peano :: *

Constructors

Zero

Succ Peano

Instances

Bounded Peano

Enum Peano

Eq Peano

Integral Peano

Data Peano

Num Peano

Ord Peano

Read Peano

Real Peano

Show Peano

Ix Peano

Typeable * Peano

class Monad m => MonadStateN n s m where

Methods

stateN :: Proxy# n -> (s -> (a, s)) -> m a

Instances

Monad m => MonadStateN Zero s (StateT s m)

Monad m => MonadStateN Zero s (StateT s m)

MonadState big m => MonadStateN Zero small (ZoomT * big small m)

(Monad (t m), MonadTrans t, MonadStateN n s m, Monad m) => MonadStateN (Succ n) s (t m)

class Monad m => MonadReaderN n r m where

Methods

askN :: Proxy# n -> m r

Instances

Monad m => MonadReaderN Zero r (StateT r m)

Monad m => MonadReaderN Zero r (StateT r m)

Monad m => MonadReaderN Zero r (ReaderT r m)

MonadReader big m => MonadReaderN Zero small (ZoomT * big small m)

(MonadTrans t, Monad (t m), MonadReaderN n r m, Monad m) => MonadReaderN (Succ n) r (t m)

class Monad m => MonadLocalN n r m where

Methods

localN :: Proxy# n -> (r -> r) -> m a -> m a

Instances

Monad m => MonadLocalN Zero r (StateT r m)

Monad m => MonadLocalN Zero r (StateT r m)

Monad m => MonadLocalN Zero r (ReaderT r m)

(MonadTrans t, Monad (t m), MFunctor t, MonadLocalN n r m, Monad m) => MonadLocalN (Succ n) r (t m)

class Monad m => MonadWriterN n w m where

Methods

tellN :: Proxy# n -> w -> m ()

Instances

(Monad m, Monoid w) => MonadWriterN Zero w (StateT w m)

(Monad m, Monoid w) => MonadWriterN Zero w (StateT w m)

(Monad m, Monoid w) => MonadWriterN Zero w (WriterT w m)

(Monad m, Monoid w) => MonadWriterN Zero w (WriterT w m)

Monad m => MonadWriterN Zero w (CustomWriterT' * w m m)

(MonadState big m, Monoid small) => MonadWriterN Zero small (ZoomT * big small m)

(MonadTrans t, Monad (t m), MonadWriterN n w m, Monad m) => MonadWriterN (Succ n) w (t m)

class Monad m => MonadExceptN n e m where

Methods

throwN :: Proxy# n -> e -> m a

Instances

Exception e => MonadExceptN Zero e IO

Monad m => MonadExceptN Zero () (MaybeT m)

Monad m => MonadExceptN Zero e (ExceptT e m)

(MonadTrans t, Monad (t m), MonadExceptN n e m, Monad m) => MonadExceptN (Succ n) e (t m)

class Monad m => MonadExecN n w m where

Methods

execN :: Proxy# n -> w a -> m a

Instances

Monad w => MonadExecN Zero w w

(MonadTrans t, Monad (t m), MonadExecN n w m, Monad m) => MonadExecN (Succ n) w (t m)

Type families

You should rarely need these. They are exported mostly for documentation and pedagogical purposes.

type Find eff m = FindTrue (MapCanDo eff m)

Find eff m finds the first transformer in a monad transformer stack that can handle the effect eff

type family FindTrue bs :: Peano

FindTrue bs returns a (type-level) index of the first occurrence of True in a list of booleans

Equations

FindTrue (True : t) = Zero

FindTrue (False : t) = Succ (FindTrue t)

type family MapCanDo eff stack :: [Bool]

MapCanDo eff stack maps the type-level function (m -> CanDo m eff) over all layers that a monad transformer stack stack consists of

Equations

MapCanDo eff (t m) = CanDo (t m) eff : MapCanDo eff m

MapCanDo eff m = `[CanDo m eff]`

type family CanDo m eff :: Bool

CanDo m eff describes whether the given effect can be performed in the monad m (without any additional lifting)

Instances

type CanDo * IO (EffExcept e) = True

type CanDo * IO (EffExec IO) = True

type CanDo * (MaybeT m) eff

type CanDo * (WriterT w m) eff

type CanDo * (WriterT w m) eff

type CanDo * (ExceptT e m) eff

type CanDo * (StateT s m) eff

type CanDo * (StateT s m) eff

type CanDo * (ReaderT e m) eff

type CanDo * (CustomWriterT' * w n m) eff

type CanDo * (ZoomT * big small m) eff