Maintainer	Nickolay Kudasov <nickolay@getshoptv.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.OpenApi.Declare

Description

Declare monad transformer and associated functions.

Synopsis

newtype DeclareT d m a = DeclareT {
- runDeclareT :: d -> m (d, a)
}
class ( Applicative m, Monad m) => MonadDeclare d m | m -> d where
- declare :: d -> m ()
- look :: m d
liftDeclare :: MonadDeclare d m => Declare d a -> m a
looks :: MonadDeclare d m => (d -> a) -> m a
evalDeclareT :: Monad m => DeclareT d m a -> d -> m a
execDeclareT :: Monad m => DeclareT d m a -> d -> m d
undeclareT :: ( Monad m, Monoid d) => DeclareT d m a -> m a
type Declare d = DeclareT d Identity
runDeclare :: Declare d a -> d -> (d, a)
evalDeclare :: Declare d a -> d -> a
execDeclare :: Declare d a -> d -> d
undeclare :: Monoid d => Declare d a -> a

Documentation

newtype DeclareT d m a Source #

A declare monad transformer parametrized by:

d — the output to accumulate (declarations);
m — the inner monad.

This monad transformer is similar to both state and writer monad transformers. Thus it can be seen as

a restricted append-only version of a state monad transformer or
a writer monad transformer with the extra ability to read all previous output.

Constructors

DeclareT
Fields runDeclareT :: d -> m (d, a)

Instances

Instances details

( Applicative m, Monad m, Monoid d) => MonadDeclare d ( DeclareT d m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> DeclareT d m () Source # look :: DeclareT d m d Source #
Monoid d => MonadTrans ( DeclareT d) Source #
Instance details Defined in Data.OpenApi.Declare Methods lift :: Monad m => m a -> DeclareT d m a Source #
( Applicative m, Monad m, Monoid d) => Monad ( DeclareT d m) Source #
Instance details Defined in Data.OpenApi.Declare Methods (>>=) :: DeclareT d m a -> (a -> DeclareT d m b) -> DeclareT d m b Source # (>>) :: DeclareT d m a -> DeclareT d m b -> DeclareT d m b Source # return :: a -> DeclareT d m a Source #
Functor m => Functor ( DeclareT d m) Source #
Instance details Defined in Data.OpenApi.Declare Methods fmap :: (a -> b) -> DeclareT d m a -> DeclareT d m b Source # (<$) :: a -> DeclareT d m b -> DeclareT d m a Source #
( Applicative m, Monad m, Monoid d) => Applicative ( DeclareT d m) Source #
Instance details Defined in Data.OpenApi.Declare Methods pure :: a -> DeclareT d m a Source # (<>) :: DeclareT d m (a -> b) -> DeclareT d m a -> DeclareT d m b Source # liftA2 :: (a -> b -> c) -> DeclareT d m a -> DeclareT d m b -> DeclareT d m c Source # (>) :: DeclareT d m a -> DeclareT d m b -> DeclareT d m b Source # (<*) :: DeclareT d m a -> DeclareT d m b -> DeclareT d m a Source #

class ( Applicative m, Monad m) => MonadDeclare d m | m -> d where Source #

Definitions of declare and look must satisfy the following laws:

monoid homomorphism (mempty): declare mempty == return ()
monoid homomorphism (mappend): declare x >> declare y == declare (x <> y) for every x , y
declare - look: declare x >> look == fmap (<> x) look <* declare x for every x
look as left identity: look >> m == m for every m

Methods

declare :: d -> m () Source #

declare x is an action that produces the output x .

look :: m d Source #

look is an action that returns all the output so far.

Instances

Instances details

MonadDeclare d m => MonadDeclare d ( MaybeT m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> MaybeT m () Source # look :: MaybeT m d Source #
( Monoid w, MonadDeclare d m) => MonadDeclare d ( WriterT w m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> WriterT w m () Source # look :: WriterT w m d Source #
( Monoid w, MonadDeclare d m) => MonadDeclare d ( WriterT w m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> WriterT w m () Source # look :: WriterT w m d Source #
MonadDeclare d m => MonadDeclare d ( StateT s m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> StateT s m () Source # look :: StateT s m d Source #
MonadDeclare d m => MonadDeclare d ( StateT s m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> StateT s m () Source # look :: StateT s m d Source #
MonadDeclare d m => MonadDeclare d ( ReaderT r m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> ReaderT r m () Source # look :: ReaderT r m d Source #
MonadDeclare d m => MonadDeclare d ( IdentityT m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> IdentityT m () Source # look :: IdentityT m d Source #
MonadDeclare d m => MonadDeclare d ( ExceptT e m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> ExceptT e m () Source # look :: ExceptT e m d Source #
( Applicative m, Monad m, Monoid d) => MonadDeclare d ( DeclareT d m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> DeclareT d m () Source # look :: DeclareT d m d Source #
MonadDeclare d m => MonadDeclare d ( ContT r m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> ContT r m () Source # look :: ContT r m d Source #
( Monoid w, MonadDeclare d m) => MonadDeclare d ( RWST r w s m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> RWST r w s m () Source # look :: RWST r w s m d Source #
( Monoid w, MonadDeclare d m) => MonadDeclare d ( RWST r w s m) Source #
Instance details Defined in Data.OpenApi.Declare Methods declare :: d -> RWST r w s m () Source # look :: RWST r w s m d Source #