transformers-0.5.0.2: Concrete functor and monad transformers

Copyright(c) Andy Gill 2001, (c) Oregon Graduate Institute of Science and Technology, 2001
LicenseBSD-style (see the file LICENSE)
MaintainerR.Paterson@city.ac.uk
Stabilityexperimental
Portabilityportable
Safe HaskellSafe
LanguageHaskell98

Control.Monad.Trans.Writer.Strict

Contents

Description

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.State.Strict instead.

Synopsis

The Writer monad

type Writer w = WriterT w Identity Source

A writer monad parameterized by the type w of output to accumulate.

The return function produces the output mempty, while >>= combines the outputs of the subcomputations using mappend.

writer :: Monad m => (a, w) -> WriterT w m a Source

Construct a writer computation from a (result, output) pair. (The inverse of runWriter.)

runWriter :: Writer w a -> (a, w) Source

Unwrap a writer computation as a (result, output) pair. (The inverse of writer.)

execWriter :: Writer w a -> w Source

Extract the output from a writer computation.

mapWriter :: ((a, w) -> (b, w')) -> Writer w a -> Writer w' b Source

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

The WriterT monad transformer

newtype WriterT w m a Source

A writer monad parameterized by:

  • w - the output to accumulate.
  • m - The inner monad.

The return function produces the output mempty, while >>= combines the outputs of the subcomputations using mappend.

Constructors

WriterT 

Fields

runWriterT :: m (a, w)
 

Instances

Monoid w => MonadTrans (WriterT w) Source 
(Monoid w, Monad m) => Monad (WriterT w m) Source 
Functor m => Functor (WriterT w m) Source 
(Monoid w, MonadFix m) => MonadFix (WriterT w m) Source 
(Monoid w, Applicative m) => Applicative (WriterT w m) Source 
Foldable f => Foldable (WriterT w f) Source 
Traversable f => Traversable (WriterT w f) Source 
(Monoid w, MonadZip m) => MonadZip (WriterT w m) Source 
(Monoid w, Alternative m) => Alternative (WriterT w m) Source 
(Monoid w, MonadPlus m) => MonadPlus (WriterT w m) Source 
(Monoid w, MonadIO m) => MonadIO (WriterT w m) Source 
(Show w, Show1 m) => Show1 (WriterT w m) Source 
(Read w, Read1 m) => Read1 (WriterT w m) Source 
(Ord w, Ord1 m) => Ord1 (WriterT w m) Source 
(Eq w, Eq1 m) => Eq1 (WriterT w m) Source 
(Eq w, Eq1 m, Eq a) => Eq (WriterT w m a) Source 
(Ord w, Ord1 m, Ord a) => Ord (WriterT w m a) Source 
(Read w, Read1 m, Read a) => Read (WriterT w m a) Source 
(Show w, Show1 m, Show a) => Show (WriterT w m a) Source 

execWriterT :: Monad m => WriterT w m a -> m w Source

Extract the output from a writer computation.

mapWriterT :: (m (a, w) -> n (b, w')) -> WriterT w m a -> WriterT w' n b Source

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

Writer operations

tell :: Monad m => w -> WriterT w m () Source

tell w is an action that produces the output w.

listen :: Monad m => WriterT w m a -> WriterT w m (a, w) Source

listen m is an action that executes the action m and adds its output to the value of the computation.

listens :: Monad m => (w -> b) -> WriterT w m a -> WriterT w m (a, b) Source

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.

pass :: Monad m => WriterT w m (a, w -> w) -> WriterT w m a Source

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.

censor :: Monad m => (w -> w) -> WriterT w m a -> WriterT w m a Source

censor f m is an action that executes the action m and applies the function f to its output, leaving the return value unchanged.

Lifting other operations

liftCallCC :: Monoid w => CallCC m (a, w) (b, w) -> CallCC (WriterT w m) a b Source

Lift a callCC operation to the new monad.

liftCatch :: Catch e m (a, w) -> Catch e (WriterT w m) a Source

Lift a catchE operation to the new monad.