Copyright | (c) Andy Gill 2001 (c) Oregon Graduate Institute of Science and Technology 2001 |
---|---|
License | BSD-style (see the file LICENSE) |
Maintainer | libraries@haskell.org |
Stability | experimental |
Portability | non-portable (multi-param classes, functional dependencies) |
Safe Haskell | Safe |
Language | Haskell2010 |
Strict RWS monad that uses continuation-passing-style to achieve constant space usage.
Inspired by the paper Functional Programming with Overloading and Higher-Order Polymorphism, Mark P Jones (http://web.cecs.pdx.edu/~mpj/) Advanced School of Functional Programming, 1995.
Since: mtl-2.3, transformers-0.5.6
Synopsis
- type RWS r w s = RWST r w s Identity
- rws :: Monoid w => (r -> s -> (a, s, w)) -> RWS r w s a
- runRWS :: Monoid w => RWS r w s a -> r -> s -> (a, s, w)
- evalRWS :: Monoid w => RWS r w s a -> r -> s -> (a, w)
- execRWS :: Monoid w => RWS r w s a -> r -> s -> (s, w)
- mapRWS :: (Monoid w, Monoid w') => ((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
- data RWST r w s (m :: Type -> Type) a
- runRWST :: Monoid w => RWST r w s m a -> r -> s -> m (a, s, w)
- evalRWST :: (Monad m, Monoid w) => RWST r w s m a -> r -> s -> m (a, w)
- execRWST :: (Monad m, Monoid w) => RWST r w s m a -> r -> s -> m (s, w)
- mapRWST :: (Monad n, Monoid w, Monoid w') => (m (a, s, w) -> n (b, s, w')) -> RWST r w s m a -> RWST r w' s n b
- withRWST :: forall r' s r w (m :: Type -> Type) a. (r' -> s -> (r, s)) -> RWST r w s m a -> RWST r' w s m a
- module Control.Monad.RWS.Class
- module Control.Monad.Trans
The RWS monad
type RWS r w s = RWST r w s Identity Source #
A monad containing an environment of type r
, output of type w
and an updatable state of type s
.
rws :: Monoid w => (r -> s -> (a, s, w)) -> RWS r w s a Source #
Construct an RWS computation from a function.
(The inverse of runRWS
.)
runRWS :: Monoid w => RWS r w s a -> r -> s -> (a, s, w) Source #
Unwrap an RWS computation as a function.
(The inverse of rws
.)
:: Monoid w | |
=> RWS r w s a | RWS computation to execute |
-> r | initial environment |
-> s | initial value |
-> (a, w) | final value and output |
Evaluate a computation with the given initial state and environment, returning the final value and output, discarding the final state.
:: Monoid w | |
=> RWS r w s a | RWS computation to execute |
-> r | initial environment |
-> s | initial value |
-> (s, w) | final state and output |
Evaluate a computation with the given initial state and environment, returning the final state and output, discarding the final value.
mapRWS :: (Monoid w, Monoid w') => ((a, s, w) -> (b, s, w')) -> RWS r w s a -> RWS r w' s b Source #
The RWST monad transformer
data RWST r w s (m :: Type -> Type) a Source #
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
.
Instances
(Monoid w, Monad m) => MonadRWS r w s (RWST r w s m) Source # | Since: mtl-2.3 |
Defined in Control.Monad.RWS.Class | |
MonadAccum w' m => MonadAccum w' (RWST r w s m) Source # | Since: mtl-2.3 |
(Monoid w, MonadError e m) => MonadError e (RWST r w s m) Source # | Since: mtl-2.3 |
Defined in Control.Monad.Error.Class throwError :: e -> RWST r w s m a Source # catchError :: RWST r w s m a -> (e -> RWST r w s m a) -> RWST r w s m a Source # | |
(Monad m, Monoid w) => MonadReader r (RWST r w s m) Source # | Since: mtl-2.3 |
MonadSelect w' m => MonadSelect w' (RWST r w s m) Source # | A combination of an 'outer' Since: mtl-2.3 |
Defined in Control.Monad.Select | |
(Monad m, Monoid w) => MonadState s (RWST r w s m) Source # | Since: mtl-2.3 |
(Monoid w, Monad m) => MonadWriter w (RWST r w s m) Source # | Since: mtl-2.3 |
MonadTrans (RWST r w s) | |
MonadFail m => MonadFail (RWST r w s m) | |
MonadFix m => MonadFix (RWST r w s m) | |
MonadIO m => MonadIO (RWST r w s m) | |
(Functor m, MonadPlus m) => Alternative (RWST r w s m) | |
(Functor m, Monad m) => Applicative (RWST r w s m) | |
Defined in Control.Monad.Trans.RWS.CPS pure :: a -> RWST r w s m a Source # (<*>) :: RWST r w s m (a -> b) -> RWST r w s m a -> RWST r w s m b Source # liftA2 :: (a -> b -> c) -> RWST r w s m a -> RWST r w s m b -> RWST r w s m c Source # (*>) :: RWST r w s m a -> RWST r w s m b -> RWST r w s m b Source # (<*) :: RWST r w s m a -> RWST r w s m b -> RWST r w s m a Source # | |
Functor m => Functor (RWST r w s m) | |
Monad m => Monad (RWST r w s m) | |
(Functor m, MonadPlus m) => MonadPlus (RWST r w s m) | |
(Monoid w, MonadCont m) => MonadCont (RWST r w s m) Source # | Since: mtl-2.3 |
Generic (RWST r w s m a) | |
type Rep (RWST r w s m a) | |
Defined in Control.Monad.Trans.RWS.CPS |
runRWST :: Monoid w => RWST r w s m a -> r -> s -> m (a, s, w) Source #
Unwrap an RWST computation as a function.
(The inverse of rwsT
.)
:: (Monad m, Monoid w) | |
=> RWST r w s m a | computation to execute |
-> r | initial environment |
-> s | initial value |
-> m (a, w) | computation yielding final value and output |
Evaluate a computation with the given initial state and environment, returning the final value and output, discarding the final state.
:: (Monad m, Monoid w) | |
=> RWST r w s m a | computation to execute |
-> r | initial environment |
-> s | initial value |
-> m (s, w) | computation yielding final state and output |
Evaluate a computation with the given initial state and environment, returning the final state and output, discarding the final value.
mapRWST :: (Monad n, Monoid w, Monoid w') => (m (a, s, w) -> n (b, s, w')) -> RWST r w s m a -> RWST r w' s n b Source #
withRWST :: forall r' s r w (m :: Type -> Type) a. (r' -> s -> (r, s)) -> RWST r w s m a -> RWST r' w s m a Source #
Strict Reader-writer-state monads
module Control.Monad.RWS.Class
module Control.Monad.Trans