 | transformers-0.2.1.0: Concrete functor and monad transformers | Contents | Index |
|
| Control.Monad.Trans.RWS.Lazy | | Portability | portable | | Stability | experimental | | Maintainer | libraries@haskell.org |
|
|
|
|
|
| Description |
| A monad transformer that combines ReaderT, WriterT and StateT.
This version is lazy; for a strict version, see
Control.Monad.Trans.RWS.Strict, which has the same interface.
|
|
| Synopsis |
|
| type RWS r w s = RWST r w s Identity | | | rws :: (r -> s -> (a, s, w)) -> RWS r w s a | | | runRWS :: RWS r w s a -> r -> s -> (a, s, w) | | | evalRWS :: RWS r w s a -> r -> s -> (a, w) | | | execRWS :: RWS r w s a -> r -> s -> (s, w) | | | mapRWS :: ((a, s, w) -> (b, s, w')) -> RWS r w s a -> RWS r w' s b | | | withRWS :: (r' -> s -> (r, s)) -> RWS r w s a -> RWS r' w s a | | | newtype RWST r w s m a = RWST {} | | | evalRWST :: Monad m => RWST r w s m a -> r -> s -> m (a, w) | | | execRWST :: Monad m => RWST r w s m a -> r -> s -> m (s, w) | | | mapRWST :: (m (a, s, w) -> n (b, s, w')) -> RWST r w s m a -> RWST r w' s n b | | | withRWST :: (r' -> s -> (r, s)) -> RWST r w s m a -> RWST r' w s m a | | | ask :: (Monoid w, Monad m) => RWST r w s m r | | | local :: (Monoid w, Monad m) => (r -> r) -> RWST r w s m a -> RWST r w s m a | | | asks :: (Monoid w, Monad m) => (r -> a) -> RWST r w s m a | | | tell :: (Monoid w, Monad m) => w -> RWST r w s m () | | | listen :: (Monoid w, Monad m) => RWST r w s m a -> RWST r w s m (a, w) | | | listens :: (Monoid w, Monad m) => (w -> b) -> RWST r w s m a -> RWST r w s m (a, b) | | | pass :: (Monoid w, Monad m) => RWST r w s m (a, w -> w) -> RWST r w s m a | | | censor :: (Monoid w, Monad m) => (w -> w) -> RWST r w s m a -> RWST r w s m a | | | get :: (Monoid w, Monad m) => RWST r w s m s | | | put :: (Monoid w, Monad m) => s -> RWST r w s m () | | | modify :: (Monoid w, Monad m) => (s -> s) -> RWST r w s m () | | | gets :: (Monoid w, Monad m) => (s -> a) -> RWST r w s m a | | | liftCallCC :: Monoid w => ((((a, s, w) -> m (b, s, w)) -> m (a, s, w)) -> m (a, s, w)) -> ((a -> RWST r w s m b) -> RWST r w s m a) -> RWST r w s m a | | | liftCallCC' :: Monoid w => ((((a, s, w) -> m (b, s, w)) -> m (a, s, w)) -> m (a, s, w)) -> ((a -> RWST r w s m b) -> RWST r w s m a) -> RWST r w s m a | | | liftCatch :: (m (a, s, w) -> (e -> m (a, s, w)) -> m (a, s, w)) -> RWST l w s m a -> (e -> RWST l w s m a) -> RWST l w s m a |
|
|
|
| The RWS monad
|
|
| type RWS r w s = RWST r w s Identity |
| A monad containing an environment of type r, output of type w
and an updatable state of type s.
|
|
| rws :: (r -> s -> (a, s, w)) -> RWS r w s a |
| Construct an RWS computation from a function.
(The inverse of runRWS.)
|
|
| runRWS :: RWS r w s a -> r -> s -> (a, s, w) |
| Unwrap an RWS computation as a function.
(The inverse of rws.)
|
|
| evalRWS :: RWS r w s a -> r -> s -> (a, w) |
|
| execRWS :: RWS r w s a -> r -> s -> (s, w) |
|
| mapRWS :: ((a, s, w) -> (b, s, w')) -> RWS r w s a -> RWS r w' s b |
|
| withRWS :: (r' -> s -> (r, s)) -> RWS r w s a -> RWS r' w s a |
|
| The RWST monad transformer
|
|
| newtype RWST r w s m a |
| A monad transformer adding reading an environment of type r,
collecting an output of type w and updating a state of type s
to an inner monad m.
| | Constructors | | RWST | | | runRWST :: r -> s -> m (a, s, w) | |
|
| Instances | |
|
|
| evalRWST :: Monad m => RWST r w s m a -> r -> s -> m (a, w) |
|
| execRWST :: Monad m => RWST r w s m a -> r -> s -> m (s, w) |
|
| mapRWST :: (m (a, s, w) -> n (b, s, w')) -> RWST r w s m a -> RWST r w' s n b |
|
| withRWST :: (r' -> s -> (r, s)) -> RWST r w s m a -> RWST r' w s m a |
|
| Reader operations
|
|
| ask :: (Monoid w, Monad m) => RWST r w s m r |
| Fetch the value of the environment.
|
|
| local :: (Monoid w, Monad m) => (r -> r) -> RWST r w s m a -> RWST r w s m a |
| Execute a computation in a modified environment
|
|
| asks :: (Monoid w, Monad m) => (r -> a) -> RWST r w s m a |
| Retrieve a function of the current environment.
|
|
| Writer operations
|
|
| tell :: (Monoid w, Monad m) => w -> RWST r w s m () |
| tell w is an action that produces the output w.
|
|
| listen :: (Monoid w, Monad m) => RWST r w s m a -> RWST r w s m (a, w) |
| listen m is an action that executes the action m and adds its
output to the value of the computation.
|
|
| listens :: (Monoid w, Monad m) => (w -> b) -> RWST r w s m a -> RWST r w s m (a, b) |
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 :: (Monoid w, Monad m) => RWST r w s m (a, w -> w) -> RWST r w s m a |
| 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 :: (Monoid w, Monad m) => (w -> w) -> RWST r w s m a -> RWST r w s m a |
censor f m is an action that executes the action m and
applies the function f to its output, leaving the return value
unchanged.
|
|
| State operations
|
|
| get :: (Monoid w, Monad m) => RWST r w s m s |
| Fetch the current value of the state within the monad.
|
|
| put :: (Monoid w, Monad m) => s -> RWST r w s m () |
| put s sets the state within the monad to s.
|
|
| modify :: (Monoid w, Monad m) => (s -> s) -> RWST r w s m () |
| modify f is an action that updates the state to the result of
applying f to the current state.
|
|
| gets :: (Monoid w, Monad m) => (s -> a) -> RWST r w s m a |
Get a specific component of the state, using a projection function
supplied.
|
|
| Lifting other operations
|
|
| liftCallCC :: Monoid w => ((((a, s, w) -> m (b, s, w)) -> m (a, s, w)) -> m (a, s, w)) -> ((a -> RWST r w s m b) -> RWST r w s m a) -> RWST r w s m a |
| Uniform lifting of a callCC operation to the new monad.
This version rolls back to the original state on entering the
continuation.
|
|
| liftCallCC' :: Monoid w => ((((a, s, w) -> m (b, s, w)) -> m (a, s, w)) -> m (a, s, w)) -> ((a -> RWST r w s m b) -> RWST r w s m a) -> RWST r w s m a |
| In-situ lifting of a callCC operation to the new monad.
This version uses the current state on entering the continuation.
|
|
| liftCatch :: (m (a, s, w) -> (e -> m (a, s, w)) -> m (a, s, w)) -> RWST l w s m a -> (e -> RWST l w s m a) -> RWST l w s m a |
| Lift a catchError operation to the new monad.
|
|
| Produced by Haddock version 2.7.2 |