| Copyright | (c) The University of Glasgow 1998-2002 |
|---|---|
| License | see libraries/base/LICENSE |
| Maintainer | ghc-devs@haskell.org |
| Stability | internal |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Trustworthy |
| Language | Haskell2010 |
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
- class (Typeable e, Show e) => Exception e where
- toException :: e -> SomeException
- fromException :: SomeException -> Maybe e
- displayException :: e -> String
- backtraceDesired :: e -> Bool
- data SomeException = (Exception e, HasExceptionContext) => SomeException e
- displayExceptionWithInfo :: SomeException -> String
- someExceptionContext :: SomeException -> ExceptionContext
- addExceptionContext :: ExceptionAnnotation a => a -> SomeException -> SomeException
- mapExceptionContext :: (ExceptionContext -> ExceptionContext) -> SomeException -> SomeException
- newtype NoBacktrace e = NoBacktrace e
- type HasExceptionContext = ?exceptionContext :: ExceptionContext
- data ExceptionContext = ExceptionContext [SomeExceptionAnnotation]
- emptyExceptionContext :: ExceptionContext
- mergeExceptionContext :: ExceptionContext -> ExceptionContext -> ExceptionContext
- data ExceptionWithContext a = ExceptionWithContext ExceptionContext a
- data WhileHandling = WhileHandling SomeException
- whileHandling :: Exception e => ExceptionWithContext e -> WhileHandling
- data ArithException
- divZeroException :: SomeException
- overflowException :: SomeException
- ratioZeroDenomException :: SomeException
- underflowException :: SomeException
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 MyExceptionThe 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 = frontendExceptionFromExceptionWe 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
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.
Constructors
| (Exception e, HasExceptionContext) => SomeException e |
Instances
| Exception SomeException Source # | This drops any attached Since: base-3.0 |
Defined in GHC.Internal.Exception.Type Methods toException :: SomeException -> SomeException Source # fromException :: SomeException -> Maybe SomeException Source # displayException :: SomeException -> String Source # backtraceDesired :: SomeException -> Bool Source # | |
| Show SomeException Source # | Since: ghc-internal-3.0 |
Defined in GHC.Internal.Exception.Type | |
displayExceptionWithInfo :: SomeException -> String Source #
Displays a SomeException with additional information:
- The type of the underlying exception
- The exception context
By default, uncaughtExceptionHandler uses displayExceptionWithInfo to print uncaught exceptions.
This default can be overriden with setUncaughtExceptionHandler, for
instance, to present custom error messages on exceptions to the user.
Since: base-4.21
someExceptionContext :: SomeException -> ExceptionContext Source #
View the ExceptionContext of a SomeException.
addExceptionContext :: ExceptionAnnotation a => a -> SomeException -> SomeException Source #
Add more ExceptionContext to a SomeException.
mapExceptionContext :: (ExceptionContext -> ExceptionContext) -> SomeException -> SomeException Source #
newtype NoBacktrace e Source #
Constructors
| NoBacktrace e |
Instances
| Exception e => Exception (NoBacktrace e) Source # | |
Defined in GHC.Internal.Exception.Type Methods toException :: NoBacktrace e -> SomeException Source # fromException :: SomeException -> Maybe (NoBacktrace e) Source # displayException :: NoBacktrace e -> String Source # backtraceDesired :: NoBacktrace e -> Bool Source # | |
| Show e => Show (NoBacktrace e) Source # | |
Defined in GHC.Internal.Exception.Type | |
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.
Constructors
| ExceptionContext [SomeExceptionAnnotation] |
Instances
| Monoid ExceptionContext Source # | |
Defined in GHC.Internal.Exception.Context Methods mempty :: ExceptionContext Source # mappend :: ExceptionContext -> ExceptionContext -> ExceptionContext Source # mconcat :: [ExceptionContext] -> ExceptionContext Source # | |
| Semigroup ExceptionContext Source # | |
Defined in GHC.Internal.Exception.Context Methods (<>) :: ExceptionContext -> ExceptionContext -> ExceptionContext Source # sconcat :: NonEmpty ExceptionContext -> ExceptionContext Source # stimes :: Integral b => b -> ExceptionContext -> ExceptionContext Source # | |
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.
Constructors
| ExceptionWithContext ExceptionContext a |
Instances
| Exception a => Exception (ExceptionWithContext a) Source # | |
Defined in GHC.Internal.Exception.Type Methods toException :: ExceptionWithContext a -> SomeException Source # fromException :: SomeException -> Maybe (ExceptionWithContext a) Source # displayException :: ExceptionWithContext a -> String Source # backtraceDesired :: ExceptionWithContext a -> Bool Source # | |
| Show a => Show (ExceptionWithContext a) Source # | |
Defined in GHC.Internal.Exception.Type | |
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.
Constructors
| WhileHandling SomeException |
Instances
| ExceptionAnnotation WhileHandling Source # | |
Defined in GHC.Internal.Exception.Type Methods displayExceptionAnnotation :: WhileHandling -> String Source # | |
| Show WhileHandling Source # | |
Defined in GHC.Internal.Exception.Type | |
whileHandling :: Exception e => ExceptionWithContext e -> WhileHandling Source #
Create SomeException from an explicit context and exception.
Arithmetic exceptions
data ArithException Source #
Arithmetic exceptions.
Constructors
| Overflow | |
| Underflow | |
| LossOfPrecision | |
| DivideByZero | |
| Denormal | |
| RatioZeroDenominator | Since: base-4.6.0.0 |