monad-finally-0.1.2.1: Guard monadic computations with cleanup actions
Safe HaskellSafe-Inferred
LanguageHaskell2010

Control.Monad.Exception

Description

A generalization of Control.Exception from the IO monad to MonadRecover SomeException.

Synopsis

Throwing exceptions

exception :: Exception e => e -> α Source #

Throw an exception from pure code.

throw :: (MonadThrow μ, Exception e) => e -> μ α Source #

Throw an exception from monadic code. An alias for abort . toException.

throwIO :: (MonadBase IO μ, Exception e) => e -> μ α Source #

Thow an exception from the IO monad.

ioError :: MonadBase IO μ => IOError -> μ α Source #

Raise an IOError in the IO monad.

throwTo :: (MonadBase IO μ, Exception e) => ThreadId -> e -> μ () Source #

Raise an exception in the target thread. See throwTo.

Catching exceptions

catch :: (MonadCatch μ, Exception e) => μ α -> (e -> μ α) -> μ α Source #

Recover from the specified type of exceptions.

handle :: (MonadCatch μ, Exception e) => (e -> μ α) -> μ α -> μ α Source #

An alias for flip catch.

catchJust Source #

Arguments

:: (MonadCatch μ, Exception e) 
=> (e -> Maybe β)

Exception predicate

-> μ α

Main computation

-> (β -> μ α)

Exception handler

-> μ α 

Recover from exceptions that satisfy the provided predicate.

handleJust :: (MonadCatch μ, Exception e) => (e -> Maybe β) -> (β -> μ α) -> μ α -> μ α Source #

An alias for flip . catchJust.

data Handler μ α Source #

Exception handler.

Constructors

forall e.Exception e => Handler (e -> μ α) 

Instances

Instances details
Functor μ => Functor (Handler μ) Source # 
Instance details

Defined in Control.Monad.Exception

Methods

fmap :: (a -> b) -> Handler μ a -> Handler μ b #

(<$) :: a -> Handler μ b -> Handler μ a #

catches :: MonadCatch μ => μ α -> [Handler μ α] -> μ α Source #

Recover from exceptions by sequentually trying to apply the provided handlers.

handles :: MonadCatch μ => [Handler μ α] -> μ α -> μ α Source #

An alias for flip catches.

try :: (MonadCatch μ, Exception e) => μ α -> μ (Either e α) Source #

Recover from exceptions of the spesified type, wrapping them into Left.

tryJust Source #

Arguments

:: (MonadCatch μ, Exception e) 
=> (e -> Maybe β)

Exception predicate

-> μ α

Main compuration

-> μ (Either β α) 

Recover from exceptions that satisfy the provided predicate, wrapping them into Left.

evaluateIO :: MonadBase IO μ => α -> μ α Source #

Evalute the argument to weak head normal form.

Asynchronous exception control

class (Applicative μ, Monad μ) => MonadMask μ where Source #

A class of monads that support masking of asynchronous exceptions.

Minimal complete definition

Nothing

Methods

getMaskingState :: μ MaskingState Source #

Get the current masking state.

default getMaskingState :: (MonadMask η, MonadTrans t, μ ~ t η) => μ MaskingState Source #

withMaskingState :: MaskingState -> μ α -> μ α Source #

Run the provided computation with the specified MaskingState.

default withMaskingState :: (MonadMask η, MonadTransControl t, μ ~ t η) => MaskingState -> μ α -> μ α Source #

Instances

Instances details
MonadMask IO Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (ListT μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (MaybeT μ) Source # 
Instance details

Defined in Control.Monad.Exception

(MonadMask μ, Error e) => MonadMask (ErrorT e μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (ExceptT e μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (ReaderT r μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (StateT s μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (StateT s μ) Source # 
Instance details

Defined in Control.Monad.Exception

(MonadMask μ, Monoid w) => MonadMask (WriterT w μ) Source # 
Instance details

Defined in Control.Monad.Exception

(MonadMask μ, Monoid w) => MonadMask (WriterT w μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (AbortT e μ) Source # 
Instance details

Defined in Control.Monad.Exception

MonadMask μ => MonadMask (FinishT β μ) Source # 
Instance details

Defined in Control.Monad.Exception

(MonadMask μ, Monoid w) => MonadMask (RWST r w s μ) Source # 
Instance details

Defined in Control.Monad.Exception

Methods

getMaskingState :: RWST r w s μ MaskingState Source #

withMaskingState :: MaskingState -> RWST r w s μ α -> RWST r w s μ α Source #

(MonadMask μ, Monoid w) => MonadMask (RWST r w s μ) Source # 
Instance details

Defined in Control.Monad.Exception

Methods

getMaskingState :: RWST r w s μ MaskingState Source #

withMaskingState :: MaskingState -> RWST r w s μ α -> RWST r w s μ α Source #

liftGetMaskingState :: (MonadMask μ, MonadTrans t) => t μ MaskingState Source #

Lift getMaskingState through a monad transformer.

liftWithMaskingState :: (MonadTransControl t, MonadMask μ, Monad (t μ)) => MaskingState -> t μ α -> t μ α Source #

Lift withMaskingState through a monad transformer.

mask :: forall μ α. MonadMask μ => ((forall η β. MonadMask η => η β -> η β) -> μ α) -> μ α Source #

Prevents asynchronous exceptions from being raised within the provided computation. Blocking operations can still be interrupted. Supplies the computation with withMaskingState s, where s is the current masking state.

mask_ :: forall μ α. MonadMask μ => μ α -> μ α Source #

An alias for mask . const.

uninterruptibleMask :: MonadMask μ => ((forall η β. MonadMask η => η β -> η β) -> μ α) -> μ α Source #

Prevents asynchronous exceptions from being raised within the provided computation. Also prevents blocking operations from being interrupted. Supplies the computation with withMaskingState s, where s is the current masking state.

uninterruptibleMask_ :: MonadMask μ => μ α -> μ α Source #

An alias for uninterruptibleMask . const.

interruptible :: MonadMask μ => μ α -> μ α Source #

Allow asynchronous exceptions to be raised within the provided computation, even if the current masking state is MaskedInterruptible (but not in MaskedUninterruptible state).

allowInterrupt :: MonadMask μ => μ () Source #

An alias for interruptible (return ()).

Re-exports

assert :: Bool -> a -> a #

If the first argument evaluates to True, then the result is the second argument. Otherwise an AssertionFailed exception is raised, containing a String with the source file and line number of the call to assert.

Assertions can normally be turned on or off with a compiler flag (for GHC, assertions are normally on unless optimisation is turned on with -O or the -fignore-asserts option is given). When assertions are turned off, the first argument to assert is ignored, and the second argument is returned as the result.

newtype TypeError #

An expression that didn't typecheck during compile time was called. This is only possible with -fdefer-type-errors. The String gives details about the failed type check.

Since: base-4.9.0.0

Constructors

TypeError String 

Instances

Instances details
Exception TypeError

Since: base-4.9.0.0

Instance details

Defined in Control.Exception.Base

Show TypeError

Since: base-4.9.0.0

Instance details

Defined in Control.Exception.Base

newtype RecUpdError #

A record update was performed on a constructor without the appropriate field. This can only happen with a datatype with multiple constructors, where some fields are in one constructor but not another. The String gives information about the source location of the record update.

Constructors

RecUpdError String 

Instances

Instances details
Exception RecUpdError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Show RecUpdError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

newtype RecSelError #

A record selector was applied to a constructor without the appropriate field. This can only happen with a datatype with multiple constructors, where some fields are in one constructor but not another. The String gives information about the source location of the record selector.

Constructors

RecSelError String 

Instances

Instances details
Exception RecSelError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Show RecSelError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

newtype RecConError #

An uninitialised record field was used. The String gives information about the source location where the record was constructed.

Constructors

RecConError String 

Instances

Instances details
Exception RecConError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Show RecConError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

newtype PatternMatchFail #

A pattern match failed. The String gives information about the source location of the pattern.

Constructors

PatternMatchFail String 

data NonTermination #

Thrown when the runtime system detects that the computation is guaranteed not to terminate. Note that there is no guarantee that the runtime system will notice whether any given computation is guaranteed to terminate or not.

Constructors

NonTermination 

newtype NoMethodError #

A class method without a definition (neither a default definition, nor a definition in the appropriate instance) was called. The String gives information about which method it was.

Constructors

NoMethodError String 

Instances

Instances details
Exception NoMethodError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Show NoMethodError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

data NestedAtomically #

Thrown when the program attempts to call atomically, from the stm package, inside another call to atomically.

Constructors

NestedAtomically 

mapException :: (Exception e1, Exception e2) => (e1 -> e2) -> a -> a #

This function maps one exception into another as proposed in the paper "A semantics for imprecise exceptions".

data SomeAsyncException #

Superclass for asynchronous exceptions.

Since: base-4.7.0.0

Constructors

Exception e => SomeAsyncException e 

data Deadlock #

There are no runnable threads, so the program is deadlocked. The Deadlock exception is raised in the main thread only.

Constructors

Deadlock 

Instances

Instances details
Exception Deadlock

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Show Deadlock

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

newtype CompactionFailed #

Compaction found an object that cannot be compacted. Functions cannot be compacted, nor can mutable objects or pinned objects. See compact.

Since: base-4.10.0.0

Constructors

CompactionFailed String 

Instances

Instances details
Exception CompactionFailed

Since: base-4.10.0.0

Instance details

Defined in GHC.IO.Exception

Show CompactionFailed

Since: base-4.10.0.0

Instance details

Defined in GHC.IO.Exception

data BlockedIndefinitelyOnSTM #

The thread is waiting to retry an STM transaction, but there are no other references to any TVars involved, so it can't ever continue.

data BlockedIndefinitelyOnMVar #

The thread is blocked on an MVar, but there are no other references to the MVar so it can't ever continue.

data AsyncException #

Asynchronous exceptions.

Constructors

StackOverflow

The current thread's stack exceeded its limit. Since an exception has been raised, the thread's stack will certainly be below its limit again, but the programmer should take remedial action immediately.

HeapOverflow

The program's heap is reaching its limit, and the program should take action to reduce the amount of live data it has. Notes:

  • It is undefined which thread receives this exception. GHC currently throws this to the same thread that receives UserInterrupt, but this may change in the future.
  • The GHC RTS currently can only recover from heap overflow if it detects that an explicit memory limit (set via RTS flags). has been exceeded. Currently, failure to allocate memory from the operating system results in immediate termination of the program.
ThreadKilled

This exception is raised by another thread calling killThread, or by the system if it needs to terminate the thread for some reason.

UserInterrupt

This exception is raised by default in the main thread of the program when the user requests to terminate the program via the usual mechanism(s) (e.g. Control-C in the console).

newtype AssertionFailed #

assert was applied to False.

Constructors

AssertionFailed String 

Instances

Instances details
Exception AssertionFailed

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Show AssertionFailed

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

data ArrayException #

Exceptions generated by array operations

Constructors

IndexOutOfBounds String

An attempt was made to index an array outside its declared bounds.

UndefinedElement String

An attempt was made to evaluate an element of an array that had not been initialized.

data AllocationLimitExceeded #

This thread has exceeded its allocation limit. See setAllocationCounter and enableAllocationLimit.

Since: base-4.8.0.0

asyncExceptionToException :: Exception e => e -> SomeException #

Since: base-4.7.0.0

data MaskingState #

Describes the behaviour of a thread when an asynchronous exception is received.

Constructors

Unmasked

asynchronous exceptions are unmasked (the normal state)

MaskedInterruptible

the state during mask: asynchronous exceptions are masked, but blocking operations may still be interrupted

MaskedUninterruptible

the state during uninterruptibleMask: asynchronous exceptions are masked, and blocking operations may not be interrupted

Instances

Instances details
Show MaskingState

Since: base-4.3.0.0

Instance details

Defined in GHC.IO

Eq MaskingState

Since: base-4.3.0.0

Instance details

Defined in GHC.IO

data IOException #

Exceptions that occur in the IO monad. An IOException records a more specific error type, a descriptive string and maybe the handle that was used when the error was flagged.

Instances

Instances details
Exception IOException

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Show IOException

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Eq IOException

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Error IOException 
Instance details

Defined in Control.Monad.Trans.Error

data ErrorCall #

This is thrown when the user calls error. The first String is the argument given to error, second String is the location.

Bundled Patterns

pattern ErrorCall :: String -> ErrorCall 

Instances

Instances details
Exception ErrorCall

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception

Show ErrorCall

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception

Eq ErrorCall

Since: base-4.7.0.0

Instance details

Defined in GHC.Exception

Ord ErrorCall

Since: base-4.7.0.0

Instance details

Defined in GHC.Exception

class (Typeable e, Show e) => Exception e where #

Any type that you wish to throw or catch as an exception must be an instance of the Exception class. The simplest case is a new exception type directly below the root:

data MyException = ThisException | ThatException
    deriving Show

instance Exception MyException

The default method definitions in the Exception class do what we need in this case. You can now throw and catch ThisException and ThatException as exceptions:

*Main> throw ThisException `catch` \e -> putStrLn ("Caught " ++ show (e :: MyException))
Caught ThisException

In more complicated examples, you may wish to define a whole hierarchy of exceptions:

---------------------------------------------------------------------
-- Make the root exception type for all the exceptions in a compiler

data SomeCompilerException = forall e . Exception e => SomeCompilerException e

instance Show SomeCompilerException where
    show (SomeCompilerException e) = show e

instance Exception SomeCompilerException

compilerExceptionToException :: Exception e => e -> SomeException
compilerExceptionToException = toException . SomeCompilerException

compilerExceptionFromException :: Exception e => SomeException -> Maybe e
compilerExceptionFromException x = do
    SomeCompilerException a <- fromException x
    cast a

---------------------------------------------------------------------
-- Make a subhierarchy for exceptions in the frontend of the compiler

data SomeFrontendException = forall e . Exception e => SomeFrontendException e

instance Show SomeFrontendException where
    show (SomeFrontendException e) = show e

instance Exception SomeFrontendException where
    toException = compilerExceptionToException
    fromException = compilerExceptionFromException

frontendExceptionToException :: Exception e => e -> SomeException
frontendExceptionToException = toException . SomeFrontendException

frontendExceptionFromException :: Exception e => SomeException -> Maybe e
frontendExceptionFromException x = do
    SomeFrontendException a <- fromException x
    cast a

---------------------------------------------------------------------
-- Make an exception type for a particular frontend compiler exception

data MismatchedParentheses = MismatchedParentheses
    deriving Show

instance Exception MismatchedParentheses where
    toException   = frontendExceptionToException
    fromException = frontendExceptionFromException

We can now catch a MismatchedParentheses exception as MismatchedParentheses, SomeFrontendException or SomeCompilerException, but not other types, e.g. IOException:

*Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: MismatchedParentheses))
Caught MismatchedParentheses
*Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeFrontendException))
Caught MismatchedParentheses
*Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeCompilerException))
Caught MismatchedParentheses
*Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: IOException))
*** Exception: MismatchedParentheses

Minimal complete definition

Nothing

Methods

toException :: e -> SomeException #

fromException :: SomeException -> Maybe e #

displayException :: e -> String #

Render this exception value in a human-friendly manner.

Default implementation: show.

Since: base-4.8.0.0

Instances

Instances details
Exception NestedAtomically

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception NoMethodError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception NonTermination

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception PatternMatchFail

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecConError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecSelError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecUpdError

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception TypeError

Since: base-4.9.0.0

Instance details

Defined in Control.Exception.Base

Exception ErrorCall

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception

Exception ArithException

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception.Type

Exception SomeException

Since: base-3.0

Instance details

Defined in GHC.Exception.Type

Exception AllocationLimitExceeded

Since: base-4.8.0.0

Instance details

Defined in GHC.IO.Exception

Exception ArrayException

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception AssertionFailed

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception AsyncException

Since: base-4.7.0.0

Instance details

Defined in GHC.IO.Exception

Exception BlockedIndefinitelyOnMVar

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception BlockedIndefinitelyOnSTM

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception CompactionFailed

Since: base-4.10.0.0

Instance details

Defined in GHC.IO.Exception

Exception Deadlock

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception ExitCode

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception FixIOException

Since: base-4.11.0.0

Instance details

Defined in GHC.IO.Exception

Exception IOException

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception SomeAsyncException

Since: base-4.7.0.0

Instance details

Defined in GHC.IO.Exception

data SomeException #

The SomeException type is the root of the exception type hierarchy. When an exception of type e is thrown, behind the scenes it is encapsulated in a SomeException.

Constructors

Exception e => SomeException e 

Instances

Instances details
Exception SomeException

Since: base-3.0

Instance details

Defined in GHC.Exception.Type

Show SomeException

Since: base-3.0

Instance details

Defined in GHC.Exception.Type

MonadAbort SomeException STM 
Instance details

Defined in Control.Monad.Abort.Class

Methods

abort :: SomeException -> STM α #

MonadAbort SomeException IO 
Instance details

Defined in Control.Monad.Abort.Class

Methods

abort :: SomeException -> IO α #

MonadRecover SomeException STM 
Instance details

Defined in Control.Monad.Abort.Class

Methods

recover :: STM α -> (SomeException -> STM α) -> STM α #

evaluate :: STM α -> STM (Either SomeException α) #

MonadRecover SomeException IO 
Instance details

Defined in Control.Monad.Abort.Class

Methods

recover :: IO α -> (SomeException -> IO α) -> IO α #

evaluate :: IO α -> IO (Either SomeException α) #