Moduletransformers-0.6.3.0Haskell2010
Control.Monad.Trans.Writer.Strict
The strict WriterT monad transformer, which adds collection of outputs (such as a count or string output) to a given monad.
This monad transformer provides only limited access to the output during the computation. For more general access, use Control.Monad.Trans.State instead.
This version builds its output strictly; for a lazy version with the same interface, see Control.Monad.Trans.Writer.Lazy. Although the output is built strictly, it is not possible to achieve constant space behaviour with this transformer: for that, use Control.Monad.Trans.Writer.CPS instead.
Synopsis
- type Writer
- value writer
- value runWriter
- value execWriter
- value mapWriter
- newtype WriterT
- value execWriterT
- value mapWriterT
- value tell
- value listen
- value listens
- value pass
- value censor
- value liftCallCC
- value liftCatch
- Packagetransformers-0.6.3.0
- Exports15
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceStrict.hs
The Writer monad
Construct a writer computation from a (result, output) pair. (The inverse of runWriter.)
Unwrap a writer computation as a (result, output) pair. (The inverse of writer.)
Extract the output from a writer computation.
execWriter m = snd (runWriter m)
The WriterT monad transformer
A writer monad parameterized by:
w- the output to accumulate.m- The inner monad.
The return function produces the output mempty, while m >>= k
combines the outputs of the subcomputations using mappend (also
known as <>):
Constructors
WriterTrunWriterT :: m (a, w)
Instances23MonadTrans, Monad, Functor, MonadFix, MonadFail, Applicative, …
Monoid w => MonadTrans (WriterT w)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, Monad m) => Monad (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.StrictFunctor m => Functor (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, MonadFix m) => MonadFix (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, MonadFail m) => MonadFail (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, Applicative m) => Applicative (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.StrictFoldable f => Foldable (WriterT w f)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.StrictTraversable f => Traversable (WriterT w f)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, Alternative m) => Alternative (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, MonadPlus m) => MonadPlus (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, MonadIO m) => MonadIO (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Monoid w, MonadZip m) => MonadZip (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Eq w, Eq1 m) => Eq1 (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Ord w, Ord1 m) => Ord1 (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Read w, Read1 m) => Read1 (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Show w, Show1 m) => Show1 (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.StrictContravariant m => Contravariant (WriterT w m)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Eq w, Eq1 m, Eq a) => Eq (WriterT w m a)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Ord w, Ord1 m, Ord a) => Ord (WriterT w m a)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Read w, Read1 m, Read a) => Read (WriterT w m a)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict(Show w, Show1 m, Show a) => Show (WriterT w m a)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.StrictGeneric (WriterT w m a)Defined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Stricttype Rep (WriterT w m a) = D1 ('MetaDataDefined in transformers-0.6.3.0 · Control.Monad.Trans.Writer.Strict"WriterT"
"Control.Monad.Trans.Writer.Strict"
"transformers-0.6.3.0-34b4"
'True) (C1 ('MetaCons"WriterT"
'PrefixI 'True) (S1 ('MetaSel ('Just"runWriterT"
) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (m (a, w)))))
Extract the output from a writer computation.
execWriterT m = liftM snd (runWriterT m)
Map both the return value and output of a computation using the given function.
runWriterT (mapWriterT f m) = f (runWriterT m)
Writer operations
tell w is an action that produces the output w.
listen m is an action that executes the action m and adds its
output to the value of the computation.
runWriterT (listen m) = liftM (\ (a, w) -> ((a, w), w)) (runWriterT m)
listens f m is an action that executes the action m and adds
the result of applying f to the output to the value of the computation.
listens f m = liftM (id *** f) (listen m)runWriterT (listens f m) = liftM (\ (a, w) -> ((a, f w), w)) (runWriterT m)
pass m is an action that executes the action m, which returns
a value and a function, and returns the value, applying the function
to the output.
runWriterT (pass m) = liftM (\ ((a, f), w) -> (a, f w)) (runWriterT m)
censor f m is an action that executes the action m and
applies the function f to its output, leaving the return value
unchanged.
censor f m = pass (liftM (\ x -> (x,f)) m)runWriterT (censor f m) = liftM (\ (a, w) -> (a, f w)) (runWriterT m)
Lifting other operations
Lift a callCC operation to the new monad.
The uniformity property (see Control.Monad.Signatures) implies that
the lifted callCC discards any output from the body on entering
the saved continuation.
Lift a catchE operation to the new monad.
The uniformity property (see Control.Monad.Signatures) implies that
the lifted catchE discards any output from the body on entering
the handler.