| Copyright | (c) Michael Weber <michael.weber@post.rwth-aachen.de> 2001 (c) Jeff Newbern 2003-2006 (c) Andriy Palamarchuk 2006 |
|---|---|
| License | BSD-style (see the file libraries/base/LICENSE) |
| Maintainer | libraries@haskell.org |
| Stability | experimental |
| Portability | non-portable (multi-parameter type classes) |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Control.Monad.Error.Class
Description
- Computation type:
- Computations which may fail or throw exceptions.
- Binding strategy:
- Failure records information about the cause/location of the failure. Failure values bypass the bound function, other values are used as inputs to the bound function.
- Useful for:
- Building computations from sequences of functions that may fail or using exception handling to structure error handling.
- Zero and plus:
- Zero is represented by an empty error and the plus operation executes its second argument if the first fails.
- Example type:
EitherString a
The Error monad (also called the Exception monad).
- class Monad m => MonadError m where
- type ErrorType m
Documentation
class Monad m => MonadError m where Source #
The strategy of combining computations that can throw exceptions by bypassing bound functions from the point an exception is thrown to the point that it is handled.
Is parameterized over the type of error information and
the monad type constructor.
It is common to use Either StringMonadError class.
You can also define your own error type and/or use a monad type constructor
other than Either StringEither IOErrorError
and/or MonadError classes.
Minimal complete definition
Methods
throwError :: ErrorType m -> m a Source #
Is used within a monadic computation to begin exception processing.
catchError :: m a -> (ErrorType m -> m a) -> m a Source #
A handler function to handle previous errors and return to normal execution. A common idiom is:
do { action1; action2; action3 } `catchError` handlerwhere the action functions can call throwError.
Note that handler and the do-block must have the same return type.
Instances
| MonadError IO Source # | |
| MonadError (Either e) Source # | |
| (Monoid w, MonadError m) => MonadError (WriterT w m) Source # | |
| (Monoid w, MonadError m) => MonadError (WriterT w m) Source # | |
| MonadError m => MonadError (StateT s m) Source # | |
| MonadError m => MonadError (StateT s m) Source # | |
| Monad m => MonadError (ExceptT e m) Source # | |
| MonadError m => MonadError (ReaderT * r m) Source # | |
| (Monoid w, MonadError m) => MonadError (RWST r w s m) Source # | |
| (Monoid w, MonadError m) => MonadError (RWST r w s m) Source # | |