mtl-2.2.1: Monad classes, using functional dependencies

Copyright | (c) Andy Gill 2001 (c) Oregon Graduate Institute of Science and Technology 2001 (c) Jeff Newbern 2003-2007 (c) Andriy Palamarchuk 2007
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 | Haskell98

Control.Monad.Reader

Contents

- MonadReader class
- The Reader monad
- The ReaderT monad transformer
- Example 1: Simple Reader Usage
- Example 2: Modifying Reader Content With `local`
- Example 3: `ReaderT` Monad Transformer

Description

Computation type:
  Computations which read values from a shared environment.
Binding strategy:
  Monad values are functions from the environment to a value. The bound function is applied to the bound value, and both have access to the shared environment.
Useful for:
  Maintaining variable bindings, or other shared environment.
Zero and plus:
  None.
Example type:
  ``Reader` [(String,Value)] a`

The `Reader` monad (also called the Environment monad). Represents a computation, which can read values from a shared environment, pass values from function to function, and execute sub-computations in a modified environment. Using `Reader` monad for such computations is often clearer and easier than using the `State` monad.

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.

Synopsis

- class Monad m => MonadReader r m | m -> r where
- asks :: MonadReader r m => (r -> a) -> m a
- type Reader r = ReaderT * r Identity
- runReader :: Reader r a -> r -> a
- mapReader :: (a -> b) -> Reader r a -> Reader r b
- withReader :: (r' -> r) -> Reader r a -> Reader r' a
- newtype ReaderT k r m a :: forall k. * -> (k -> *) -> k -> * = ReaderT {
  - runReaderT :: r -> m a
  }
- runReaderT :: ReaderT k r m a -> r -> m a
- mapReaderT :: (m a -> n b) -> ReaderT k1 r m a -> ReaderT k r n b
- withReaderT :: (r' -> r) -> ReaderT k r m a -> ReaderT k r' m a
- module Control.Monad
- module Control.Monad.Fix
- module Control.Monad.Trans

# MonadReader class

class Monad m => MonadReader r m | m -> r where Source #

See examples in Control.Monad.Reader. Note, the partially applied function type `(->) r` is a simple reader monad. See the `instance` declaration below.

Minimal complete definition

(ask | reader), local

Methods

ask :: m r Source #

Retrieves the monad environment.

local :: (r -> r) -> m a -> m a Source #

Executes a computation in a modified environment.

reader :: (r -> a) -> m a Source #

Retrieves a function of the current environment.

Instances

MonadReader r m => MonadReader r (MaybeT m) Source # |
Methods ask :: MaybeT m r Source # local :: (r -> r) -> MaybeT m a -> MaybeT m a Source # reader :: (r -> a) -> MaybeT m a Source #
MonadReader r m => MonadReader r (ListT m) Source # |
Methods ask :: ListT m r Source # local :: (r -> r) -> ListT m a -> ListT m a Source # reader :: (r -> a) -> ListT m a Source #
MonadReader r ((->) r) Source # |
Methods ask :: r -> r Source # local :: (r -> r) -> (r -> a) -> r -> a Source # reader :: (r -> a) -> r -> a Source #
(Monoid w, MonadReader r m) => MonadReader r (WriterT w m) Source # |
Methods ask :: WriterT w m r Source # local :: (r -> r) -> WriterT w m a -> WriterT w m a Source # reader :: (r -> a) -> WriterT w m a Source #
(Monoid w, MonadReader r m) => MonadReader r (WriterT w m) Source # |
Methods ask :: WriterT w m r Source # local :: (r -> r) -> WriterT w m a -> WriterT w m a Source # reader :: (r -> a) -> WriterT w m a Source #
MonadReader r m => MonadReader r (StateT s m) Source # |
Methods ask :: StateT s m r Source # local :: (r -> r) -> StateT s m a -> StateT s m a Source # reader :: (r -> a) -> StateT s m a Source #
MonadReader r m => MonadReader r (StateT s m) Source # |
Methods ask :: StateT s m r Source # local :: (r -> r) -> StateT s m a -> StateT s m a Source # reader :: (r -> a) -> StateT s m a Source #
MonadReader r m => MonadReader r (IdentityT * m) Source # |
Methods ask :: IdentityT * m r Source # local :: (r -> r) -> IdentityT * m a -> IdentityT * m a Source # reader :: (r -> a) -> IdentityT * m a Source #
MonadReader r m => MonadReader r (ExceptT e m) Source # |
Methods ask :: ExceptT e m r Source # local :: (r -> r) -> ExceptT e m a -> ExceptT e m a Source # reader :: (r -> a) -> ExceptT e m a Source #
(Error e, MonadReader r m) => MonadReader r (ErrorT e m) Source # |
Methods ask :: ErrorT e m r Source # local :: (r -> r) -> ErrorT e m a -> ErrorT e m a Source # reader :: (r -> a) -> ErrorT e m a Source #
MonadReader r' m => MonadReader r' (ContT * r m) Source # |
Methods ask :: ContT * r m r' Source # local :: (r' -> r') -> ContT * r m a -> ContT * r m a Source # reader :: (r' -> a) -> ContT * r m a Source #
Monad m => MonadReader r (ReaderT * r m) Source # |
Methods ask :: ReaderT * r m r Source # local :: (r -> r) -> ReaderT * r m a -> ReaderT * r m a Source # reader :: (r -> a) -> ReaderT * r m a Source #
(Monad m, Monoid w) => MonadReader r (RWST r w s m) Source # |
Methods ask :: RWST r w s m r Source # local :: (r -> r) -> RWST r w s m a -> RWST r w s m a Source # reader :: (r -> a) -> RWST r w s m a Source #
(Monad m, Monoid w) => MonadReader r (RWST r w s m) Source # |
Methods ask :: RWST r w s m r Source # local :: (r -> r) -> RWST r w s m a -> RWST r w s m a Source # reader :: (r -> a) -> RWST r w s m a Source #

asks Source #

Arguments

:: MonadReader r m |
=> (r -> a) | The selector function to apply to the environment.
-> m a |

Retrieves a function of the current environment.

# The Reader monad

type Reader r = ReaderT * r Identity #

The parameterizable reader monad.

Computations are functions of a shared environment.

The `return` function ignores the environment, while `>>=` passes the inherited environment to both subcomputations.

runReader #

Arguments

:: Reader r a | A `Reader` to run.
-> r | An initial environment.
-> a |

Runs a `Reader` and extracts the final value from it. (The inverse of `reader`.)

mapReader :: (a -> b) -> Reader r a -> Reader r b #

Transform the value returned by a `Reader`.

-     runReader (mapReader f m) = f . runReader m

withReader #

Arguments

:: (r' -> r) | The function to modify the environment.
-> Reader r a | Computation to run in the modified environment.
-> Reader r' a |

Execute a computation in a modified environment (a specialization of `withReaderT`).

-     runReader (withReader f m) = runReader m . f

# The ReaderT monad transformer

newtype ReaderT k r m a :: forall k. * -> (k -> *) -> k -> * #

The reader monad transformer, which adds a read-only environment to the given monad.

The `return` function ignores the environment, while `>>=` passes the inherited environment to both subcomputations.

Constructors

ReaderT |

Fields

- runReaderT :: r -> m a

Instances

MonadWriter w m => MonadWriter w (ReaderT * r m) Source # |
Methods writer :: (a, w) -> ReaderT * r m a Source # tell :: w -> ReaderT * r m () Source # listen :: ReaderT * r m a -> ReaderT * r m (a, w) Source # pass :: ReaderT * r m (a, w -> w) -> ReaderT * r m a Source #
MonadState s m => MonadState s (ReaderT * r m) Source # |
Methods get :: ReaderT * r m s Source # put :: s -> ReaderT * r m () Source # state :: (s -> (a, s)) -> ReaderT * r m a Source #
Monad m => MonadReader r (ReaderT * r m) Source # |
Methods ask :: ReaderT * r m r Source # local :: (r -> r) -> ReaderT * r m a -> ReaderT * r m a Source # reader :: (r -> a) -> ReaderT * r m a Source #
MonadError e m => MonadError e (ReaderT * r m) Source # |
Methods throwError :: e -> ReaderT * r m a Source # catchError :: ReaderT * r m a -> (e -> ReaderT * r m a) -> ReaderT * r m a Source #
MonadTrans (ReaderT * r) |
Methods lift :: Monad m => m a -> ReaderT * r m a #
Monad m => Monad (ReaderT * r m) |
Methods (>>=) :: ReaderT * r m a -> (a -> ReaderT * r m b) -> ReaderT * r m b # (>>) :: ReaderT * r m a -> ReaderT * r m b -> ReaderT * r m b # return :: a -> ReaderT * r m a # fail :: String -> ReaderT * r m a #
Functor m => Functor (ReaderT * r m) |
Methods fmap :: (a -> b) -> ReaderT * r m a -> ReaderT * r m b # (<$) :: a -> ReaderT * r m b -> ReaderT * r m a #
MonadFix m => MonadFix (ReaderT * r m) |
Methods mfix :: (a -> ReaderT * r m a) -> ReaderT * r m a #
MonadFail m => MonadFail (ReaderT * r m) |
Methods fail :: String -> ReaderT * r m a #
Applicative m => Applicative (ReaderT * r m) |
Methods pure :: a -> ReaderT * r m a # (<*>) :: ReaderT * r m (a -> b) -> ReaderT * r m a -> ReaderT * r m b # (*>) :: ReaderT * r m a -> ReaderT * r m b -> ReaderT * r m b # (<*) :: ReaderT * r m a -> ReaderT * r m b -> ReaderT * r m a #
MonadZip m => MonadZip (ReaderT * r m) |
Methods mzip :: ReaderT * r m a -> ReaderT * r m b -> ReaderT * r m (a, b) # mzipWith :: (a -> b -> c) -> ReaderT * r m a -> ReaderT * r m b -> ReaderT * r m c # munzip :: ReaderT * r m (a, b) -> (ReaderT * r m a, ReaderT * r m b) #
MonadIO m => MonadIO (ReaderT * r m) |
Methods liftIO :: IO a -> ReaderT * r m a #
Alternative m => Alternative (ReaderT * r m) |
Methods empty :: ReaderT * r m a # (<|>) :: ReaderT * r m a -> ReaderT * r m a -> ReaderT * r m a # some :: ReaderT * r m a -> ReaderT * r m [a] # many :: ReaderT * r m a -> ReaderT * r m [a] #
MonadPlus m => MonadPlus (ReaderT * r m) |
Methods mzero :: ReaderT * r m a # mplus :: ReaderT * r m a -> ReaderT * r m a -> ReaderT * r m a #
MonadCont m => MonadCont (ReaderT * r m) Source # |
Methods callCC :: ((a -> ReaderT * r m b) -> ReaderT * r m a) -> ReaderT * r m a Source #

runReaderT :: ReaderT k r m a -> r -> m a #

mapReaderT :: (m a -> n b) -> ReaderT k1 r m a -> ReaderT k r n b #

Transform the computation inside a `ReaderT`.

-     runReaderT (mapReaderT f m) = f . runReaderT m

withReaderT #

Arguments

:: (r' -> r) | The function to modify the environment.
-> ReaderT k r m a | Computation to run in the modified environment.
-> ReaderT k r' m a |

Execute a computation in a modified environment (a more general version of `local`).

-     runReaderT (withReaderT f m) = runReaderT m . f

module Control.Monad

module Control.Monad.Fix

module Control.Monad.Trans

# Example 1: Simple Reader Usage

In this example the `Reader` monad provides access to variable bindings. Bindings are a `Map` of integer variables. The variable `count` contains number of variables in the bindings. You can see how to run a Reader monad and retrieve data from it with `runReader`, how to access the Reader data with `ask` and `asks`.

     type Bindings = Map String Int;

    -- Returns True if the "count" variable contains correct bindings size.
    isCountCorrect :: Bindings -> Bool
    isCountCorrect bindings = runReader calc_isCountCorrect bindings

    -- The Reader monad, which implements this complicated check.
    calc_isCountCorrect :: Reader Bindings Bool
    calc_isCountCorrect = do
        count <- asks (lookupVar "count")
        bindings <- ask
        return (count == (Map.size bindings))

    -- The selector function to  use with 'asks'.
    -- Returns value of the variable with specified name.
    lookupVar :: String -> Bindings -> Int
    lookupVar name bindings = fromJust (Map.lookup name bindings)

    sampleBindings = Map.fromList [("count",3), ("1",1), ("b",2)]

    main = do
        putStr $ "Count is correct for bindings " ++ (show sampleBindings) ++ ": ";
        putStrLn $ show (isCountCorrect sampleBindings);

# Example 2: Modifying Reader Content With `local`

Shows how to modify Reader content with `local`.

    calculateContentLen :: Reader String Int
    calculateContentLen = do
        content <- ask
        return (length content);

    -- Calls calculateContentLen after adding a prefix to the Reader content.
    calculateModifiedContentLen :: Reader String Int
    calculateModifiedContentLen = local ("Prefix " ++) calculateContentLen

    main = do
        let s = "12345";
        let modifiedLen = runReader calculateModifiedContentLen s
        let len = runReader calculateContentLen s
        putStrLn $ "Modified 's' length: " ++ (show modifiedLen)
        putStrLn $ "Original 's' length: " ++ (show len)

# Example 3: `ReaderT` Monad Transformer

Now you are thinking: 'Wow, what a great monad! I wish I could use Reader functionality in MyFavoriteComplexMonad!'. Don't worry. This can be easy done with the `ReaderT` monad transformer. This example shows how to combine `ReaderT` with the IO monad.

    -- The Reader/IO combined monad, where Reader stores a string.
    printReaderContent :: ReaderT String IO ()
    printReaderContent = do
        content <- ask
        liftIO $ putStrLn ("The Reader Content: " ++ content)

    main = do
        runReaderT printReaderContent "Some Content"