The Monad Transformer Library
mtl
MTL is a collection of monad classes, extending the
transformerspackage, using functional dependencies for generic lifting of monadic actions.
Transformers in MTL are divided into classes and data types. Classes define the monadic operations of transformers. Data types, generally from the
transformerspackage, implement transformers, and MTL provides instances for all the transformer type classes.
MTL and
transformersuse a common module, data type, and function naming scheme. As an example, let's imagine we have a transformer
Foo.
In the
Control.Monad.Foomodule, we'd find:
MonadFoowith the transformer operations.
FooTwith instances for all monad transformer classes.
runFooT. For the actual transformers, there are usually a number of useful runner functions.
When using monad transformers, you often need to "lift" a monadic action into your transformed monadic action. This is done using the
liftfunction from
MonadTransin the
Control.Monad.Trans.Classmodule:
lift :: (Monad m, MonadTrans t) => m a -> t m a
The action
m ais lifted into the transformer action
t m a.
As an example, here we lift an action of type
IO ainto an action of type
ExceptT MyError IO a:
data MyError = EmptyLinemightFail :: ExceptT MyError IO () mightFail = do l
Transformers
The following outlines the available monad classes and transformers in MTL and
transformers. For more details, and the corresponding documentation of themtlversion you are using, see the documentation on Hackage.
Control.Monad.Cont
The Continuation monad transformer adds the ability to use continuation-passing style (CPS) in a monadic computation. Continuations can be used to manipulate the control flow of a program, e.g. early exit, error handling, or suspending a computation.
Control.Monad.Cont.Class.MonadCont
Control.Monad.Cont.ContT
Control.Monad.Error(deprecated!)
The Error monad transformer has been deprecated in favor of
Control.Monad.Except.
Control.Monad.Except
The Except monad transformer adds the ability to fail with an error in a monadic computation.
Control.Monad.Except.Class.MonadError
Control.Monad.Except.ExceptT
Control.Monad.Identity
The Identity monad transformer does not add any abilities to a monad. It simply applies the bound function to its inner monad without any modification.
Control.Monad.Trans.Identity.IdentityT(in the
transformerspackage)
Data.Functor.Identity.Identity(in the
basepackage)
Control.Monad.List
This transformer combines the list monad with another monad. Note that this does not yield a monad unless the inner monad is commutative.
Control.Monad.List.ListT
Control.Monad.RWS
A convenient transformer that combines the Reader, Writer, and State monad transformers.
Control.Monad.RWS.Lazy.RWST(which is the default, exported by
Control.Monad.RWS)
Control.Monad.RWS.Strict.RWST
Control.Monad.Reader
The Reader monad transformer represents a computation which can read values from an environment.
Control.Monad.Reader.Class.MonadReader
Control.Monad.Reader.ReaderT
Control.Monad.State
The State monad transformer represents a computation which can read and write internal state values. If you only need to read values, you might want to use Reader instead.
Control.Monad.State.Class.MonadState
Control.Monad.State.Lazy.StateT(the default, exported by
Control.Monad.State)
Control.Monad.State.Strict.StateT
Control.Monad.Writer
The Writer monad transformer represents a computation that can produce a stream of data in addition to the computed values. This can be used to collect values in some data structure with a
Monoidinstance. This can be used for things like logging and accumulating values throughout a computation.
Control.Monad.Writer.Class.MonadWriter
Control.Monad.Writer.Lazy.WriterT
Control.Monad.Writer.Strict.WriterT
mtlon Hackage