Control.Effect

Core API

newtype Eff f m a

The Eff monad transformer is used to write programs that require access to specific effects. In this library, effects are combined by stacking multiple Effs together, just as you would do with traditional monad transformers. Effs are parameterized by an effect algebra. This is a description of programs in a single effect, such as non-determinism ([])or exceptions (Either e). As Eff is a monad transformer, m is the monad that Eff transforms, which can itself be another instance of Eff.

Constructors

Eff (forall g r. (forall x. Sum f m x -> Cont (g r) x) -> Cont (g r) a)

Instances

(Monad m, Interprets f (Eff h m)) => Interprets f (Eff g (Eff h m))

Methods

interpret :: f a -> Eff g (Eff h m) a

Monad m => Interprets f (Eff f m)

Methods

interpret :: f a -> Eff f m a

EffEnvironment env m => EffEnvironment env (Eff effects m)

Methods

liftReader :: Reader env a -> Eff effects m a

Monad m => EffEnvironment env (Eff (Reader env) m)

Methods

liftReader :: Reader env a -> Eff (Reader env) m a

EffException e m => EffException e (Eff f m)

Methods

liftEither :: Either e a -> Eff f m a

Monad m => EffException e (Eff (Either e) m)

Methods

liftEither :: Either e a -> Eff (Either e) m a

MonadTrans (Eff f)

Methods

lift :: Monad m => m a -> Eff f m a

Monad (Eff f m)

Methods

(>>=) :: Eff f m a -> (a -> Eff f m b) -> Eff f m b

(>>) :: Eff f m a -> Eff f m b -> Eff f m b

return :: a -> Eff f m a

fail :: String -> Eff f m a

Functor (Eff f m)

Methods

fmap :: (a -> b) -> Eff f m a -> Eff f m b

(<$) :: a -> Eff f m b -> Eff f m a

Applicative (Eff f m)

Methods

pure :: a -> Eff f m a

(<*>) :: Eff f m (a -> b) -> Eff f m a -> Eff f m b

(*>) :: Eff f m a -> Eff f m b -> Eff f m b

(<*) :: Eff f m a -> Eff f m b -> Eff f m a

MonadIO m => MonadIO (Eff effect m)

Methods

liftIO :: IO a -> Eff effect m a

EffUIO m => EffUIO (Eff r m)

Methods

liftUIO :: UIO a -> Eff r m a

Monad m => Nondeterministic (Eff [] m)

Methods

liftNondeterminism :: [a] -> Eff [] m a

Nondeterministic m => Nondeterministic (Eff f m)

Methods

liftNondeterminism :: [a] -> Eff f m a

translate :: (Monad m, Monad (t m), MonadTrans t) => (forall x r. f x -> ContT r (t m) x) -> Eff f m a -> t m a

In order to run Eff computations, we need to provide a way to run its effects in a specific monad transformer. Notice that run eliminates one layer of Eff, returning you with the original a now captured under the result of the effects described by the effect functor.

class (IsEff m, Monad m) => Interprets p m | m -> p where

LiftProgram defines an mtl-style type class for automatically lifting effects into Eff stacks. When exporting libraries that you intend to publish on Hackage, it's suggested that you still provide your own type class (such as MonadThrow or MonadHTTP) to avoid locking people into this library, but interpret can be useful to define your own instances of that type class for Eff.

Minimal complete definition

interpret

Methods

interpret :: p a -> m a

Instances

(Monad m, Interprets f (Eff h m)) => Interprets f (Eff g (Eff h m))

Methods

interpret :: f a -> Eff g (Eff h m) a

Monad m => Interprets f (Eff f m)

Methods

interpret :: f a -> Eff f m a

interpret :: Interprets p m => p a -> m a

type family IsEff (m :: * -> *) :: Constraint where ...

The IsEff type family is used to make sure that a given monad stack is based around Eff. This is important, as it allows us to reason about Eff-based type classes, knowing that only Eff implements them, thus giving us the orthogonal-handling properties that we desire.

Equations

IsEff (Eff f m) = ()