Safe Haskell	Safe
Language	Haskell98

Control.Monad.Chronicle.Class

Description

Hybrid error/writer monad class that allows both accumulating outputs and aborting computation with a final output.

The expected use case is for computations with a notion of fatal vs. non-fatal errors.

Synopsis

Documentation

class Monad m => MonadChronicle c m | m -> c where Source

Methods

dictate :: c -> m () Source

dictate c is an action that records the output c.

Equivalent to tell for the Writer monad.

confess :: c -> m a Source

confess c is an action that ends with a final output c.

Equivalent to throwError for the Error monad.

memento :: m a -> m (Either c a) Source

memento m is an action that executes the action m, returning either its record if it ended with confess, or its final value otherwise, with any record added to the current record.

Similar to catchError in the Error monad, but with a notion of non-fatal errors (which are accumulated) vs. fatal errors (which are caught without accumulating).

absolve :: a -> m a -> m a Source

absolve x m is an action that executes the action m and discards any record it had. The default value x will be used if m ended via confess.

condemn :: m a -> m a Source

condemn m is an action that executes the action m and keeps its value only if it had no record. Otherwise, the value (if any) will be discarded and only the record kept.

This can be seen as converting non-fatal errors into fatal ones.

retcon :: (c -> c) -> m a -> m a Source

retcon f m is an action that executes the action m and applies the function f to its output, leaving the return value unchanged.

Equivalent to censor for the Writer monad.

chronicle :: These c a -> m a Source

chronicle m lifts a plain 'These c a' value into a MonadChronicle instance.

Instances

MonadChronicle c m => MonadChronicle c (MaybeT m) Source
MonadChronicle c m => MonadChronicle c (IdentityT m) Source
Monoid c => MonadChronicle c (These c) Source
(Monoid w, MonadChronicle c m) => MonadChronicle c (WriterT w m) Source
(Monoid w, MonadChronicle c m) => MonadChronicle c (WriterT w m) Source
MonadChronicle c m => MonadChronicle c (StateT s m) Source
MonadChronicle c m => MonadChronicle c (StateT s m) Source
MonadChronicle c m => MonadChronicle c (ReaderT r m) Source
(Error e, MonadChronicle c m) => MonadChronicle c (ErrorT e m) Source
(Monoid c, Monad m) => MonadChronicle c (ChronicleT c m) Source
(Monoid w, MonadChronicle c m) => MonadChronicle c (RWST r w s m) Source
(Monoid w, MonadChronicle c m) => MonadChronicle c (RWST r w s m) Source

newtype ChronicleT c m a Source

The ChronicleT monad transformer.

The return function produces a computation with no output, and >>= combines multiple outputs with mappend.

Constructors

ChronicleT
Fields runChronicleT :: m (These c a)

Instances

(Monoid c, MonadRWS r w s m) => MonadRWS r w s (ChronicleT c m) Source
(Monoid c, MonadError e m) => MonadError e (ChronicleT c m) Source
(Monoid c, MonadReader r m) => MonadReader r (ChronicleT c m) Source
(Monoid c, MonadState s m) => MonadState s (ChronicleT c m) Source
(Monoid c, MonadWriter w m) => MonadWriter w (ChronicleT c m) Source
(Monoid c, Monad m) => MonadChronicle c (ChronicleT c m) Source
Monoid c => MonadTrans (ChronicleT c) Source
(Monoid c, Monad m) => Monad (ChronicleT c m) Source
Functor m => Functor (ChronicleT c m) Source
(Monoid c, Applicative m) => Applicative (ChronicleT c m) Source
(Monoid c, Applicative m, Monad m) => Alternative (ChronicleT c m) Source
(Monoid c, Monad m) => MonadPlus (ChronicleT c m) Source
(Monoid c, MonadIO m) => MonadIO (ChronicleT c m) Source
(Monoid c, Apply m) => Apply (ChronicleT c m) Source
(Monoid c, Apply m, Monad m) => Bind (ChronicleT c m) Source

runChronicle :: Chronicle c a -> These c a Source