Control.Monad.Error.Class

Copyright (c) Michael Weber <[email protected]> 2001
(c) Jeff Newbern 2003-2006
(c) Andriy Palamarchuk 2006
(c) Edward Kmett 2012
License BSD-style (see the file LICENSE)
Maintainer [email protected]
Stability experimental
Portability non-portable (multi-parameter type classes)
Safe Haskell Safe
Language Haskell2010

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:
Either String a

The Error monad (also called the Exception monad).

class Error a where Source

An exception to be thrown.

Minimal complete definition: noMsg or strMsg.

Minimal complete definition

Nothing

Methods

noMsg :: a Source

Creates an exception without a message. The default implementation is strMsg "".

strMsg :: String -> a Source

Creates an exception with a message. The default implementation of strMsg s is noMsg.

Instances
Instances details
Error IOException
Instance details

Defined in Control.Monad.Trans.Error

ErrorList a => Error [a]

A string can be thrown as an error.

Instance details

Defined in Control.Monad.Trans.Error

Methods

noMsg :: [a] Source

strMsg :: String -> [a] Source

class Monad m => MonadError e m | m -> e 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 String as the monad type constructor for an error monad in which error descriptions take the form of strings. In that case and many other common cases the resulting monad is already defined as an instance of the MonadError class. You can also define your own error type and/or use a monad type constructor other than Either String or Either IOError. In these cases you will have to explicitly define instances of the MonadError class. (If you are using the deprecated Control.Monad.Error or Control.Monad.Trans.Error, you may also have to define an Error instance.)

Methods

throwError :: e -> m a Source

Is used within a monadic computation to begin exception processing.

catchError :: m a -> (e -> 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` handler

where the action functions can call throwError. Note that handler and the do-block must have the same return type.

Instances
Instances details
MonadError () Maybe

Since: mtl-2.2.2

Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: () -> Maybe a Source

catchError :: Maybe a -> (() -> Maybe a) -> Maybe a Source

MonadError IOException IO
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: IOException -> IO a Source

catchError :: IO a -> (IOException -> IO a) -> IO a Source

MonadError e m => MonadError e (MaybeT m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> MaybeT m a Source

catchError :: MaybeT m a -> (e -> MaybeT m a) -> MaybeT m a Source

MonadError e m => MonadError e (ListT m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> ListT m a Source

catchError :: ListT m a -> (e -> ListT m a) -> ListT m a Source

MonadError e (Either e)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> Either e a Source

catchError :: Either e a -> (e -> Either e a) -> Either e a Source

(Monoid w, MonadError e m) => MonadError e (WriterT w m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> WriterT w m a Source

catchError :: WriterT w m a -> (e -> WriterT w m a) -> WriterT w m a Source

(Monoid w, MonadError e m) => MonadError e (WriterT w m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> WriterT w m a Source

catchError :: WriterT w m a -> (e -> WriterT w m a) -> WriterT w m a Source

MonadError e m => MonadError e (StateT s m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> StateT s m a Source

catchError :: StateT s m a -> (e -> StateT s m a) -> StateT s m a Source

MonadError e m => MonadError e (StateT s m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> StateT s m a Source

catchError :: StateT s m a -> (e -> StateT s m a) -> StateT s m a Source

MonadError e m => MonadError e (ReaderT r m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> ReaderT r m a Source

catchError :: ReaderT r m a -> (e -> ReaderT r m a) -> ReaderT r m a Source

MonadError e m => MonadError e (IdentityT m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> IdentityT m a Source

catchError :: IdentityT m a -> (e -> IdentityT m a) -> IdentityT m a Source

Monad m => MonadError e (ExceptT e m)

Since: mtl-2.2

Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> ExceptT e m a Source

catchError :: ExceptT e m a -> (e -> ExceptT e m a) -> ExceptT e m a Source

(Monad m, Error e) => MonadError e (ErrorT e m)
Instance details

Defined in Control.Monad.Error.Class

Methods

throwError :: e -> ErrorT e m a Source

catchError :: ErrorT e m a -> (e -> ErrorT e m a) -> ErrorT e m a Source

(Monoid w, MonadError e m) => MonadError e (RWST r w s m)
Instance details

Defined in Control.Monad.Error.Class

Methods

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

(Monoid w, MonadError e m) => MonadError e (RWST r w s m)
Instance details

Defined in Control.Monad.Error.Class

Methods

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

liftEither :: MonadError e m => Either e a -> m a Source

Lifts an Either e into any MonadError e.

do { val <- liftEither =<< action1; action2 }

where action1 returns an Either to represent errors.

Since: mtl-2.2.2

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/8.10.2/docs/html/libraries/mtl-2.2.2/Control-Monad-Error-Class.html