Control.Error.Context.Types

Provides an API for enriching errors with contexts.

Documentation

data ErrorContext

Constructors

ErrorContext

Fields

• errorContextKVs :: HashMap Text Value
• errorContextNamespace :: [Text]

Instances

Monoid ErrorContext

Methods

mempty :: ErrorContext

mappend :: ErrorContext -> ErrorContext -> ErrorContext

mconcat :: [ErrorContext] -> ErrorContext

data ErrorWithContext e

Boundles an error with an ErrorContext.

Constructors

ErrorWithContext ErrorContext e

Instances

Functor ErrorWithContext

Methods

fmap :: (a -> b) -> ErrorWithContext a -> ErrorWithContext b

(<$) :: a -> ErrorWithContext b -> ErrorWithContext a

Show e => Show (ErrorWithContext e)

Methods

showsPrec :: Int -> ErrorWithContext e -> ShowS

show :: ErrorWithContext e -> String

showList :: [ErrorWithContext e] -> ShowS

Exception e => Exception (ErrorWithContext e)

An ErrorWithContext e can be used as an exception.

Methods

toException :: ErrorWithContext e -> SomeException

fromException :: SomeException -> Maybe (ErrorWithContext e)

displayException :: ErrorWithContext e -> String

errorContextAsString :: ErrorContext -> String

class (Monad m, MonadThrow m) => MonadErrorContext m where

Monad type class providing contextualized errors.

Minimal complete definition

errorContextCollect, withErrorContext, withErrorNamespace

Methods

errorContextCollect

Arguments

:: m ErrorContext

Return the current error context.

withErrorContext :: ToJSON v => Text -> v -> m a -> m a

withErrorNamespace :: Text -> m a -> m a

Instances

MonadCatch m => MonadErrorContext (ErrorContextT m)

Methods

errorContextCollect :: ErrorContextT m ErrorContext

withErrorContext :: ToJSON v => Text -> v -> ErrorContextT m a -> ErrorContextT m a

withErrorNamespace :: Text -> ErrorContextT m a -> ErrorContextT m a

(MonadCatch m, KatipContext m) => MonadErrorContext (ErrorContextKatipT m)

Methods

errorContextCollect :: ErrorContextKatipT m ErrorContext

withErrorContext :: ToJSON v => Text -> v -> ErrorContextKatipT m a -> ErrorContextKatipT m a

withErrorNamespace :: Text -> ErrorContextKatipT m a -> ErrorContextKatipT m a