Panic

Documentation

data Panic a

The exception thrown when panicing.

Constructors

Panic

Fields

• panicComponent :: a
• panicLoc :: String
• panicMsg :: [String]
• panicStack :: CallStack

Instances

PanicComponent a => Show (Panic a)

Methods

showsPrec :: Int -> Panic a -> ShowS

show :: Panic a -> String

showList :: [Panic a] -> ShowS

PanicComponent a => Exception (Panic a)

Methods

toException :: Panic a -> SomeException

fromException :: SomeException -> Maybe (Panic a)

displayException :: Panic a -> String

class Typeable a => PanicComponent a where

Description of a component.

Minimal complete definition

panicComponentName, panicComponentIssues, panicComponentRevision

Methods

panicComponentName :: a -> String

Name of the panicing component.

panicComponentIssues :: a -> String

Issue tracker for the panicking component.

panicComponentRevision :: a -> (String, String)

Information about the component's revision. (commit hash, branch info)

useGitRevision :: Q Exp

An expression of type a -> (String,String). Uses template Haskell to query Git for the current state of the repo. Note that the state reported depends on when the module containing the splice was compiled.

type HasCallStack = ?callStack :: CallStack

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

Since: 4.9.0.0

panic

Arguments

:: (PanicComponent a, HasCallStack)

=> a

Component identification

-> String

Location of problem

-> [String]

Problem description (lines)

-> b

Throw an exception for the given component.