haskell / 9 / libraries / base-4.17.0.0 / ghc-exception-type.html

GHC.Exception.Type

Copyright (c) The University of Glasgow 1998-2002
License see libraries/base/LICENSE
Maintainer cvs-ghc@haskell.org
Stability internal
Portability non-portable (GHC extensions)
Safe Haskell Trustworthy
Language Haskell2010

Description

Exceptions and exception-handling functions.

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

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

Instances
Instances details
Exception NestedAtomically Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception NoMethodError Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception NonTermination Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception PatternMatchFail Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecConError Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecSelError Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception RecUpdError Source

Since: base-4.0

Instance details

Defined in Control.Exception.Base

Exception TypeError Source

Since: base-4.9.0.0

Instance details

Defined in Control.Exception.Base

Exception Dynamic Source

Since: base-4.0.0.0

Instance details

Defined in Data.Dynamic

Exception Void Source

Since: base-4.8.0.0

Instance details

Defined in Data.Void

Exception ErrorCall Source

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception

Exception ArithException Source

Since: base-4.0.0.0

Instance details

Defined in GHC.Exception.Type

Exception SomeException Source

Since: base-3.0

Instance details

Defined in GHC.Exception.Type

Exception AllocationLimitExceeded Source

Since: base-4.8.0.0

Instance details

Defined in GHC.IO.Exception

Exception ArrayException Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception AssertionFailed Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception AsyncException Source

Since: base-4.7.0.0

Instance details

Defined in GHC.IO.Exception

Exception BlockedIndefinitelyOnMVar Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception BlockedIndefinitelyOnSTM Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception CompactionFailed Source

Since: base-4.10.0.0

Instance details

Defined in GHC.IO.Exception

Exception Deadlock Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception ExitCode Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception FixIOException Source

Since: base-4.11.0.0

Instance details

Defined in GHC.IO.Exception

Exception IOException Source

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Exception SomeAsyncException Source

Since: base-4.7.0.0

Instance details

Defined in GHC.IO.Exception

Exception FileLockingNotSupported Source
Instance details

Defined in GHC.IO.Handle.Lock.Common

Exception Timeout Source

Since: base-4.7.0.0

Instance details

Defined in System.Timeout

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

forall e.Exception e => SomeException e

data ArithException Source

Arithmetic exceptions.

divZeroException :: SomeException Source

overflowException :: SomeException Source

ratioZeroDenomException :: SomeException Source

underflowException :: SomeException Source

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/9.4.2/docs/libraries/base-4.17.0.0/GHC-Exception-Type.html