Control.Error.Context

Provides an API for enriching errors with contexts.

Documentation

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

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 ErrorContextT m a

Data type implementing MonadErrorContext.

Instances

MonadTrans ErrorContextT

Methods

lift :: Monad m => m a -> ErrorContextT m a

MonadWriter w m => MonadWriter w (ErrorContextT m)

Methods

writer :: (a, w) -> ErrorContextT m a

tell :: w -> ErrorContextT m ()

listen :: ErrorContextT m a -> ErrorContextT m (a, w)

pass :: ErrorContextT m (a, w -> w) -> ErrorContextT m a

MonadState s m => MonadState s (ErrorContextT m)

Methods

get :: ErrorContextT m s

put :: s -> ErrorContextT m ()

state :: (s -> (a, s)) -> ErrorContextT m a

MonadReader r m => MonadReader r (ErrorContextT m)

Methods

ask :: ErrorContextT m r

local :: (r -> r) -> ErrorContextT m a -> ErrorContextT m a

reader :: (r -> a) -> ErrorContextT m a

Monad m => Monad (ErrorContextT m)

Methods

(>>=) :: ErrorContextT m a -> (a -> ErrorContextT m b) -> ErrorContextT m b

(>>) :: ErrorContextT m a -> ErrorContextT m b -> ErrorContextT m b

return :: a -> ErrorContextT m a

fail :: String -> ErrorContextT m a

Functor m => Functor (ErrorContextT m)

Methods

fmap :: (a -> b) -> ErrorContextT m a -> ErrorContextT m b

(<$) :: a -> ErrorContextT m b -> ErrorContextT m a

Applicative m => Applicative (ErrorContextT m)

Methods

pure :: a -> ErrorContextT m a

(<*>) :: ErrorContextT m (a -> b) -> ErrorContextT m a -> ErrorContextT m b

liftA2 :: (a -> b -> c) -> ErrorContextT m a -> ErrorContextT m b -> ErrorContextT m c

(*>) :: ErrorContextT m a -> ErrorContextT m b -> ErrorContextT m b

(<*) :: ErrorContextT m a -> ErrorContextT m b -> ErrorContextT m a

(MonadCatch m, MonadIO m) => MonadIO (ErrorContextT m)

Methods

liftIO :: IO a -> ErrorContextT m a

(MonadCatch m, MonadResource m) => MonadResource (ErrorContextT m)

Methods

liftResourceT :: ResourceT IO a -> ErrorContextT m a

MonadCatch m => MonadThrow (ErrorContextT m)

Methods

throwM :: Exception e => e -> ErrorContextT m a

MonadCatch m => MonadCatch (ErrorContextT m)

Methods

catch :: Exception e => ErrorContextT m a -> (e -> ErrorContextT m a) -> ErrorContextT m a

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

runErrorContextT :: ErrorContextT m a -> m a

newtype ErrorContextKatipT m a

Data type implementing MonadErrorContext.

Constructors

ErrorContextKatipT

Fields

• runErrorContextKatipT :: m a

Instances

MonadTrans ErrorContextKatipT

Methods

lift :: Monad m => m a -> ErrorContextKatipT m a

MonadWriter w m => MonadWriter w (ErrorContextKatipT m)

Methods

writer :: (a, w) -> ErrorContextKatipT m a

tell :: w -> ErrorContextKatipT m ()

listen :: ErrorContextKatipT m a -> ErrorContextKatipT m (a, w)

pass :: ErrorContextKatipT m (a, w -> w) -> ErrorContextKatipT m a

MonadState s m => MonadState s (ErrorContextKatipT m)

Methods

get :: ErrorContextKatipT m s

put :: s -> ErrorContextKatipT m ()

state :: (s -> (a, s)) -> ErrorContextKatipT m a

MonadReader r m => MonadReader r (ErrorContextKatipT m)

Methods

ask :: ErrorContextKatipT m r

local :: (r -> r) -> ErrorContextKatipT m a -> ErrorContextKatipT m a

reader :: (r -> a) -> ErrorContextKatipT m a

Monad m => Monad (ErrorContextKatipT m)

Methods

(>>=) :: ErrorContextKatipT m a -> (a -> ErrorContextKatipT m b) -> ErrorContextKatipT m b

(>>) :: ErrorContextKatipT m a -> ErrorContextKatipT m b -> ErrorContextKatipT m b

return :: a -> ErrorContextKatipT m a

fail :: String -> ErrorContextKatipT m a

Functor m => Functor (ErrorContextKatipT m)

Methods

fmap :: (a -> b) -> ErrorContextKatipT m a -> ErrorContextKatipT m b

(<$) :: a -> ErrorContextKatipT m b -> ErrorContextKatipT m a

Applicative m => Applicative (ErrorContextKatipT m)

Methods

pure :: a -> ErrorContextKatipT m a

(<*>) :: ErrorContextKatipT m (a -> b) -> ErrorContextKatipT m a -> ErrorContextKatipT m b

liftA2 :: (a -> b -> c) -> ErrorContextKatipT m a -> ErrorContextKatipT m b -> ErrorContextKatipT m c

(*>) :: ErrorContextKatipT m a -> ErrorContextKatipT m b -> ErrorContextKatipT m b

(<*) :: ErrorContextKatipT m a -> ErrorContextKatipT m b -> ErrorContextKatipT m a

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

Methods

liftIO :: IO a -> ErrorContextKatipT m a

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

Methods

liftResourceT :: ResourceT IO a -> ErrorContextKatipT m a

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

Methods

throwM :: Exception e => e -> ErrorContextKatipT m a

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

Methods

catch :: Exception e => ErrorContextKatipT m a -> (e -> ErrorContextKatipT m a) -> ErrorContextKatipT m a

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

Methods

getKatipContext :: ErrorContextKatipT m LogContexts

localKatipContext :: (LogContexts -> LogContexts) -> ErrorContextKatipT m a -> ErrorContextKatipT m a

getKatipNamespace :: ErrorContextKatipT m Namespace

localKatipNamespace :: (Namespace -> Namespace) -> ErrorContextKatipT m a -> ErrorContextKatipT m a

(MonadCatch m, KatipContext m, MonadIO m, Katip m) => Katip (ErrorContextKatipT m)

Methods

getLogEnv :: ErrorContextKatipT m LogEnv

localLogEnv :: (LogEnv -> LogEnv) -> ErrorContextKatipT m a -> ErrorContextKatipT 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

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

errorContextualize :: MonadErrorContext m => e -> m (ErrorWithContext e)

Enrich an error value with an error context.

errorContextForget :: ErrorWithContext e -> e

Forgets the context from an enriched error.

errorWithContextDump :: (Show e, MonadIO m) => ErrorWithContext e -> m ()

Dump an error with context to stdout.

catchWithoutContext :: forall a e m. (MonadCatch m, Exception e) => m a -> (e -> m a) -> m a

Like catch, but the handler is required to be context-unaware. Is also able to catch exceptions with context, in which case the context will be forgotten before the exception will be provided to the handler.

catchWithContext :: (MonadCatch m, Exception e) => m a -> (ErrorWithContext e -> m a) -> m a

Like catch, but the handler is required to be context-aware. Is also able to catch exceptions of type e (without context).

catchAnyWithContext :: MonadCatch m => m a -> (ErrorWithContext SomeException -> m a) -> m a

Context aware version of catchAny.

catchAnyWithoutContext :: MonadCatch m => m a -> (SomeException -> m a) -> m a

Context aware version of catchAny.

ensureExceptionContext :: (MonadCatch m, MonadErrorContext m) => m a -> m a

tryAnyWithContext :: MonadCatch m => m a -> m (Either (ErrorWithContext SomeException) a)

tryAnyWithoutContext :: MonadCatch m => m a -> m (Either SomeException a)

tryWithContext :: (MonadCatch m, Exception e) => m a -> m (Either (ErrorWithContext e) a)

tryWithoutContext :: (MonadCatch m, Exception e) => m a -> m (Either e a)