Copyright	(C) Dimitri Sabadie
License	BSD3
Maintainer	dimitri.sabadie@gmail.com
Stability	stable
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Control.Monad.Journal.Class

Contents

MonadJournal

Description

MonadWriter on steroids.

MonadJournal is a more controlable version of MonadWriter because it enables you to access the Monoid being computed up. You can then access logs inside the computation itself, whereas you cannot with MonadWriter – unless you use specific functions like listen, but that still stacks Monoid in the monad.

Typically, you can use MonadJournal when you come across the logging problem and you need logs as long as you proceed.

Synopsis

class (Monoid w, Monad m) => MonadJournal w m | m -> w where
- journal :: w -> m ()
- history :: m w
- clear :: m ()
sink :: (MonadJournal w m, MonadIO m) => (w -> IO ()) -> m ()
absorb :: MonadJournal w m => (a, w) -> m a

MonadJournal

class (Monoid w, Monad m) => MonadJournal w m | m -> w where Source #

This typeclass provides the ability to accumulate Monoid in a monad via the journal function; to get them via the history function and finally, to purge them all with the clear function.

In most cases, you won’t need history neither clear. There’s a cool function that combines both and enables you to deal with the Monoid: sink.

Methods

journal :: w -> m () Source #

Log something.

history :: m w Source #

Extract the logs history.

clear :: m () Source #

Clear the logs history.

Instances

Instances details

(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (MaybeT m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> MaybeT m () Source # history :: MaybeT m w Source # clear :: MaybeT m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (ListT m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> ListT m () Source # history :: ListT m w Source # clear :: ListT m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (ExceptT e m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> ExceptT e m () Source # history :: ExceptT e m w Source # clear :: ExceptT e m () Source #
(Monad m, Monoid w, Monoid q, MonadJournal w m) => MonadJournal w (WriterT q m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> WriterT q m () Source # history :: WriterT q m w Source # clear :: WriterT q m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (StateT s m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> StateT s m () Source # history :: StateT s m w Source # clear :: StateT s m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (ReaderT r m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> ReaderT r m () Source # history :: ReaderT r m w Source # clear :: ReaderT r m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (IdentityT m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> IdentityT m () Source # history :: IdentityT m w Source # clear :: IdentityT m () Source #
(Monoid w, Monad m) => MonadJournal w (JournalT w m) Source #
Instance details Defined in Control.Monad.Trans.Journal Methods journal :: w -> JournalT w m () Source # history :: JournalT w m w Source # clear :: JournalT w m () Source #
(Monad m, Monoid w, MonadJournal w m) => MonadJournal w (RWST r w s m) Source #
Instance details Defined in Control.Monad.Journal.Class Methods journal :: w -> RWST r w s m () Source # history :: RWST r w s m w Source # clear :: RWST r w s m () Source #

sink :: (MonadJournal w m, MonadIO m) => (w -> IO ()) -> m () Source #

Sink all logs history through MonadIO then clean it.

absorb :: MonadJournal w m => (a, w) -> m a Source #

Absorb a logs history and pass around the value.