Control.Monad.Apiary

Documentation

data ApiaryT exts prms actM m a

most generic Apiary monad. since 0.8.0.0.

Instances

(Monad actM, MonadBase b m) => MonadBase b (ApiaryT exts prms actM m)

(Monad actM, MonadBaseControl b m) => MonadBaseControl b (ApiaryT exts prms actM m)

Monad actM => MonadTrans (ApiaryT exts prms actM)

Monad actM => MonadTransControl (ApiaryT exts prms actM)

Monad actM => Monad (ApiaryT exts prms actM m)

Functor (ApiaryT exts prms actM m)

Monad actM => Applicative (ApiaryT exts prms actM m)

(Monad actM, MonadIO m) => MonadIO (ApiaryT exts prms actM m)

data StT (ApiaryT exts prms actM) = StTApiary' {

• unStTApiary' :: (a, ApiaryWriter exts actM)

}

data StM (ApiaryT exts prms actM m) = StMApiary' {

• unStMApiary' :: ComposeSt (ApiaryT exts prms actM) m a

}

type EApplication e m = Extensions e -> m Application

server :: Monad m => (Application -> m a) -> EApplication [] m -> m a

serverWith :: Monad m => Initializer m [] exts -> (Application -> m a) -> EApplication exts m -> m a

runApiaryT :: (Monad actM, Monad m) => (forall b. actM b -> IO b) -> ApiaryConfig -> ApiaryT exts [] actM m () -> EApplication exts m

runApiary :: Monad m => ApiaryConfig -> ApiaryT exts [] IO m () -> EApplication exts m

getter

apiaryConfig :: Monad actM => ApiaryT exts prms actM m ApiaryConfig

apiaryExt :: (Has e exts, Monad actM) => proxy e -> ApiaryT exts prms actM m e

execute action

action :: Monad actM => Fn prms (ActionT exts actM ()) -> ApiaryT exts prms actM m ()

splice ActionT ApiaryT.

action' :: Monad actM => (SList prms -> ActionT exts actM ()) -> ApiaryT exts prms actM m ()

like action. but not apply arguments. since 0.8.0.0.

middleware

middleware :: Monad actM => Middleware -> ApiaryT exts prms actM m ()

API documentation

group :: Text -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()

API document group. since 0.12.0.0.

only top level group recognized.

document :: Text -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()

add API document. since 0.12.0.0.

It use only filters prior document, so you should be placed document directly in front of action.

precondition :: Html -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()

add user defined precondition. since 0.13.0.

noDoc :: ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()

rpHtml :: Html -> Int -> Html

construct Html as route parameter. since 0.13.0.

deprecated

actionWithPreAction :: Monad actM => (SList xs -> ActionT exts actM a) -> Fn xs (ActionT exts actM ()) -> ApiaryT exts xs actM m ()

Deprecated: use action'

execute action before main action. since 0.4.2.0