HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulelifted-base-0.2.3.12Haskell98

Control.Exception.Lifted

This is a wrapped version of Control.Exception with types generalized from IO to all monads in either MonadBase or MonadBaseControl.

  • 24 types
  • 1 class
  • 31 values
valueinterruptible :: IO a -> IO a
#

Allow asynchronous exceptions to be raised even inside mask, making the operation interruptible (see the discussion of "Interruptible operations" in Control.Exception).

When called outside mask, or inside uninterruptibleMask, this function has no effect.

classclass (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

Methods

Instances31Exception, …
valueassert :: 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.

datadata MaskingState
#

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

Constructors

Instances2Eq, Show
valuemapException :: (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".

valuethrow :: (HasCallStack, Exception e) => e -> a
#

Throw an exception. Exceptions may be thrown from purely functional code, but may only be caught within the IO monad.

WARNING: You may want to use throwIO instead so that your pure code stays exception-free.

newtypenewtype 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

Instances2Show, Exception
datadata 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.

Instances2Show, Exception
newtypenewtype RecConError
#

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

Constructors

Instances2Show, Exception
  • Show RecConErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
  • Exception RecConErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
newtypenewtype 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

Instances2Show, Exception
  • Show RecSelErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
  • Exception RecSelErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
newtypenewtype 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

Instances2Show, Exception
  • Show RecUpdErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
  • Exception RecUpdErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
newtypenewtype 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.

Constructors

Instances2Show, Exception
  • Show TypeErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
  • Exception TypeErrorDefined in ghc-internal-9.1003.0 · GHC.Internal.Control.Exception.Base
datadata ErrorCall
#

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

Instances4Eq, Ord, Show, Exception
  • Eq ErrorCallDefined in ghc-internal-9.1003.0 · GHC.Internal.Exception
  • Ord ErrorCallDefined in ghc-internal-9.1003.0 · GHC.Internal.Exception
  • Show ErrorCallDefined in ghc-internal-9.1003.0 · GHC.Internal.Exception
  • Exception ErrorCallDefined in ghc-internal-9.1003.0 · GHC.Internal.Exception
datadata ArrayException
#

Exceptions generated by array operations

Constructors

Instances4Eq, Ord, Show, Exception
datadata 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).

Instances4Eq, Ord, Show, Exception
datadata Deadlock
#

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

Instances2Show, Exception
  • Show DeadlockDefined in ghc-internal-9.1003.0 · GHC.Internal.IO.Exception
  • Exception DeadlockDefined in ghc-internal-9.1003.0 · GHC.Internal.IO.Exception
datadata 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.

Instances3Eq, Show, Exception

Throwing exceptions

3 declarations

Catching exceptions

0 declarations

The catch functions

valuecatch
  1. :: (MonadBaseControl IO m, Exception e)
  2. => m a

    The computation to run

  3. -> (e -> m a)

    Handler to invoke if an exception is raised

  4. -> m a
#

Generalized version of catch.

Note, when the given computation throws an exception any monadic side effects in m will be discarded.

valuecatches :: MonadBaseControl IO m => m a -> [Handler m a] -> m a
#

Generalized version of catches.

Note, when the given computation throws an exception any monadic side effects in m will be discarded.

valuecatchJust
  1. :: (MonadBaseControl IO m, Exception e)
  2. => (e -> Maybe b)

    Predicate to select exceptions

  3. -> m a

    Computation to run

  4. -> (b -> m a)

    Handler

  5. -> m a
#

Generalized version of catchJust.

Note, when the given computation throws an exception any monadic side effects in m will be discarded.

The handle functions

valuehandle :: (MonadBaseControl IO m, Exception e) => (e -> m a) -> m a -> m a
#

Generalized version of handle.

Note, when the given computation throws an exception any monadic side effects in m will be discarded.

The try functions

valuetry :: (MonadBaseControl IO m, Exception e) => m a -> m (Either e a)
#

Generalized version of try.

Note, when the given computation throws an exception any monadic side effects in m will be discarded.

The evaluate function

Asynchronous Exceptions

0 declarations

Asynchronous exception control

The following functions allow a thread to control delivery of asynchronous exceptions during a critical region.

Brackets

3 declarations
valuebracket
  1. :: MonadBaseControl IO m
  2. => m a

    computation to run first ("acquire resource")

  3. -> (a -> m b)

    computation to run last ("release resource")

  4. -> (a -> m c)

    computation to run in-between

  5. -> m c
#

Generalized version of bracket.

Note:

  • When the "acquire" or "release" computations throw exceptions any monadic side effects in m will be discarded.

  • When the "in-between" computation throws an exception any monadic side effects in m produced by that computation will be discarded but the side effects of the "acquire" or "release" computations will be retained.

  • Also, any monadic side effects in m of the "release" computation will be discarded; it is run only for its side effects in IO.

Note that when your acquire and release computations are of type IO it will be more efficient to write:

liftBaseOp (bracket acquire release)
valuebracket_
  1. :: MonadBaseControl IO m
  2. => m a

    computation to run first ("acquire resource")

  3. -> m b

    computation to run last ("release resource")

  4. -> m c

    computation to run in-between

  5. -> m c
#

Generalized version of bracket_.

Note any monadic side effects in m of both the "acquire" and "release" computations will be discarded. To keep the monadic side effects of the "acquire" computation, use bracket with constant functions instead.

Note that when your acquire and release computations are of type IO it will be more efficient to write:

liftBaseOp_ (bracket_ acquire release)
valuebracketOnError
  1. :: MonadBaseControl IO m
  2. => m a

    computation to run first ("acquire resource")

  3. -> (a -> m b)

    computation to run last ("release resource")

  4. -> (a -> m c)

    computation to run in-between

  5. -> m c
#

Generalized version of bracketOnError.

Note:

  • When the "acquire" or "release" computations throw exceptions any monadic side effects in m will be discarded.

  • When the "in-between" computation throws an exception any monadic side effects in m produced by that computation will be discarded but the side effects of the "acquire" computation will be retained.

  • Also, any monadic side effects in m of the "release" computation will be discarded; it is run only for its side effects in IO.

Note that when your acquire and release computations are of type IO it will be more efficient to write:

liftBaseOp (bracketOnError acquire release)

Utilities

2 declarations
valuefinally
  1. :: MonadBaseControl IO m
  2. => m a

    computation to run first

  3. -> m b

    computation to run afterward (even if an exception was raised)

  4. -> m a
#

Generalized version of finally.

Note, any monadic side effects in m of the "afterward" computation will be discarded.