Copyright	(C) 2013 Ross Paterson (C) 2015 Edward Kmett
License	BSD-style (see the file LICENSE)
Maintainer	ross@soi.city.ac.uk
Stability	experimental
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell98

Control.Monad.Trans.Except

Contents

The Except monad
The ExceptT monad transformer
Exception operations
Lifting other operations

Description

This monad transformer extends a monad with the ability throw exceptions.

A sequence of actions terminates normally, producing a value, only if none of the actions in the sequence throws an exception. If one throws an exception, the rest of the sequence is skipped and the composite action exits with that exception.

If the value of the exception is not required, the variant in Control.Monad.Trans.Maybe may be used instead.

Synopsis

The Except monad

type Except e = ExceptT e Identity

The parameterizable exception monad.

Computations are either exceptions or normal values.

The return function returns a normal value, while >>= exits on the first exception.

except :: Either e a -> Except e a

Constructor for computations in the exception monad. (The inverse of runExcept).

runExcept :: Except e a -> Either e a

Extractor for computations in the exception monad. (The inverse of except).

mapExcept :: (Either e a -> Either e' b) -> Except e a -> Except e' b

Map the unwrapped computation using the given function.

runExcept (mapExcept f m) = f (runExcept m)

withExcept :: (e -> e') -> Except e a -> Except e' a

Transform any exceptions thrown by the computation using the given function (a specialization of withExceptT).

The ExceptT monad transformer

newtype ExceptT e m a

A monad transformer that adds exceptions to other monads.

ExceptT constructs a monad parameterized over two things:

e - The exception type.
m - The inner monad.

The return function yields a computation that produces the given value, while >>= sequences two subcomputations, exiting on the first exception.

Constructors

ExceptT
Fields runExceptT :: m (Either e a)

Instances

MonadRWS r w s m => MonadRWS r w s (ExceptT e m)
Monad m => MonadError e (ExceptT e m)
MonadReader r m => MonadReader r (ExceptT e m)
MonadState s m => MonadState s (ExceptT e m)
MonadWriter w m => MonadWriter w (ExceptT e m)
MonadTrans (ExceptT e)
(Functor m, Monad m, Monoid e) => Alternative (ExceptT e m)
Monad m => Monad (ExceptT e m)
Functor m => Functor (ExceptT e m)
MonadFix m => MonadFix (ExceptT e m)
(Monad m, Monoid e) => MonadPlus (ExceptT e m)
(Functor m, Monad m) => Applicative (ExceptT e m)
Foldable f => Foldable (ExceptT e f)
Traversable f => Traversable (ExceptT e f)
MonadIO m => MonadIO (ExceptT e m)
MonadCont m => MonadCont (ExceptT e m)
(Show e, Show1 m) => Show1 (ExceptT e m)
(Read e, Read1 m) => Read1 (ExceptT e m)
(Ord e, Ord1 m) => Ord1 (ExceptT e m)
(Eq e, Eq1 m) => Eq1 (ExceptT e m)
(Eq e, Eq1 m, Eq a) => Eq (ExceptT e m a)
(Ord e, Ord1 m, Ord a) => Ord (ExceptT e m a)
(Read e, Read1 m, Read a) => Read (ExceptT e m a)
(Show e, Show1 m, Show a) => Show (ExceptT e m a)

mapExceptT :: (m (Either e a) -> n (Either e' b)) -> ExceptT e m a -> ExceptT e' n b

Map the unwrapped computation using the given function.

runExceptT (mapExceptT f m) = f (runExceptT m)

withExceptT :: Functor m => (e -> e') -> ExceptT e m a -> ExceptT e' m a

Transform any exceptions thrown by the computation using the given function.

Exception operations

throwE :: Monad m => e -> ExceptT e m a

Signal an exception value e.

```
runExceptT (throwE e) = return (Left e)
```
```
throwE e >>= m = throwE e
```

catchE

Arguments

:: Monad m
=> ExceptT e m a	the inner computation
-> (e -> ExceptT e' m a)	a handler for exceptions in the inner computation
-> ExceptT e' m a

Handle an exception.

```
catchE h (lift m) = lift m
```
```
catchE h (throwE e) = h e
```

Lifting other operations

liftCallCC :: CallCC m (Either e a) (Either e b) -> CallCC (ExceptT e m) a b

Lift a callCC operation to the new monad.

liftListen :: Monad m => Listen w m (Either e a) -> Listen w (ExceptT e m) a

Lift a listen operation to the new monad.

liftPass :: Monad m => Pass w m (Either e a) -> Pass w (ExceptT e m) a

Lift a pass operation to the new monad.