ghc-internal-9.1200.0: Basic libraries
Copyright(c) The University of Glasgow 1998-2002
Licensesee libraries/base/LICENSE
Maintainerghc-devs@haskell.org
Stabilityinternal
Portabilitynon-portable (GHC extensions)
Safe HaskellTrustworthy
LanguageHaskell2010

GHC.Internal.Exception.Type

Description

Exceptions and exception-handling functions.

The API of this module is unstable and not meant to be consumed by the general public. If you absolutely must depend on it, make sure to use a tight upper bound, e.g., base < 4.X rather than base < 5, because the interface can change rapidly without much warning.

Synopsis

Documentation

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

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 Source #

toException should produce a SomeException with no attached ExceptionContext.

fromException :: SomeException -> Maybe e Source #

displayException :: e -> String Source #

Render this exception value in a human-friendly manner.

Default implementation: show.

Since: base-4.8.0.0

backtraceDesired :: e -> Bool Source #

Since: base-4.20.0.0

Instances

Instances details
Exception Void Source #

Since: base-4.8.0.0

Instance details

Defined in GHC.Internal.Exception.Type

Exception NestedAtomically Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception NoMatchingContinuationPrompt Source #

Since: base-4.18

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception NoMethodError Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception NonTermination Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception PatternMatchFail Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception RecConError Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception RecSelError Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception RecUpdError Source #

Since: base-4.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception TypeError Source #

Since: base-4.9.0.0

Instance details

Defined in GHC.Internal.Control.Exception.Base

Exception Dynamic Source #

Since: base-4.0.0.0

Instance details

Defined in GHC.Internal.Data.Dynamic

Exception ErrorCall Source #

Since: base-4.0.0.0

Instance details

Defined in GHC.Internal.Exception

Exception ArithException Source #

Since: base-4.0.0.0

Instance details

Defined in GHC.Internal.Exception.Type

Exception SomeException Source #

This drops any attached ExceptionContext.

Since: base-3.0

Instance details

Defined in GHC.Internal.Exception.Type

Exception AllocationLimitExceeded Source #

Since: base-4.8.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception ArrayException Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception AssertionFailed Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception AsyncException Source #

Since: base-4.7.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception BlockedIndefinitelyOnMVar Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception BlockedIndefinitelyOnSTM Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception CompactionFailed Source #

Since: base-4.10.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception Deadlock Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception ExitCode Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception FixIOException Source #

Since: base-4.11.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception IOException Source #

Since: base-4.1.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception SomeAsyncException Source #

Since: base-4.7.0.0

Instance details

Defined in GHC.Internal.IO.Exception

Exception FileLockingNotSupported Source # 
Instance details

Defined in GHC.Internal.IO.Handle.Lock.Common

Exception a => Exception (ExceptionWithContext a) Source # 
Instance details

Defined in GHC.Internal.Exception.Type

Exception e => Exception (NoBacktrace e) Source # 
Instance details

Defined in GHC.Internal.Exception.Type

data SomeException Source #

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.

Exception context

type HasExceptionContext = ?exceptionContext :: ExceptionContext Source #

A constraint used to propagate ExceptionContexts.

GHC will automatically default any unsolved HasExceptionContext constraints to an empty exception context, similarly to HasCallStack.

NOTE: The fact that HasExceptionContext is defined as an implicit parameter is an implementation detail and should not be considered a part of the API. It does however mean that any implicit parameter `?exceptionContext :: ExceptionContext` will be subject to defaulting, as described above.

Since: base-4.20.0.0

data ExceptionContext Source #

Exception context represents a list of ExceptionAnnotations. These are attached to SomeExceptions via addExceptionContext and can be used to capture various ad-hoc metadata about the exception including backtraces and application-specific context.

ExceptionContexts can be merged via concatenation using the Semigroup instance or mergeExceptionContext.

Note that GHC will automatically solve implicit constraints of type ExceptionContext with emptyExceptionContext.

emptyExceptionContext :: ExceptionContext Source #

An ExceptionContext containing no annotations.

Since: base-4.20.0.0

mergeExceptionContext :: ExceptionContext -> ExceptionContext -> ExceptionContext Source #

Merge two ExceptionContexts via concatenation

Since: base-4.20.0.0

data ExceptionWithContext a Source #

Wraps a particular exception exposing its ExceptionContext. Intended to be used when catching exceptions in cases where access to the context is desired.

Exception propagation

data WhileHandling Source #

WhileHandling is used to annotate rethrow exceptions. By inspecting the WhileHandling annotation, all the places the exception has been rethrow can be recovered.

whileHandling :: Exception e => ExceptionWithContext e -> WhileHandling Source #

Create SomeException from an explicit context and exception.

Arithmetic exceptions

data ArithException Source #

Arithmetic exceptions.