Cleff.Writer

Effect

data Writer w :: Effect where

An effect capable of accumulating monoidal outputs. This roughly corresponds to the MonadWriter typeclass and WriterT monad transformer in the mtl library.

However, note that this does not have a pass operation as we are not sure what its semantics should be. In fact, the pass semantics in mtl is also unclear and will change when handlers are put in different orders. To avoid any confusion we decided it is best that we don't include it because no one seems to be relying on it anyway.

Constructors

Tell :: w -> Writer w m ()

Listen :: m a -> Writer w m (a, w)

Operations

tell :: Writer w :> es => w -> Eff es ()

Produces an output that is appended to the accumulated value.

listen :: Writer w :> es => Eff es a -> Eff es (a, w)

Monitor the output of a computation, and return the output alongside the computation's result.

listens :: Writer w :> es => (w -> x) -> Eff es a -> Eff es (a, x)

Apply a function to the accumulated output of listen.

Interpretations

runWriter :: forall w es a. Monoid w => Eff (Writer w ': es) a -> Eff es (a, w)

Run a monoidal Writer effect.

Caveats

Both runWriter and listens under runWriter will stop taking care of writer operations done on forked threads as soon as the main thread finishes its computation. Any writer operation done before main thread finishes is still taken into account.

runWriterBatch :: forall w es a. Monoid w => Eff (Writer w ': es) a -> Eff es (a, w)

Run a monoidal Writer effect, but appends the listened output to the parent value only when the listen operation finishes. This means that when you run two listens on two threads, the values telled inside will not be appended to the parent value in real time, but only after the thread finishes listening. For example, this code

concurrently_
  (listen $ tell "1" >> tell "2" >> tell "3")
  (listen $ tell "4" >> tell "5" >> tell "6")

will produce either "123456" or "456123" with runWriterBatch, but may produce these digits in any order with runWriter.

This version of interpreter can be faster than runWriter in listen-intense code. It is subject to all caveats of runWriter.

Since: 0.2.0.0