| Safe Haskell | None |
|---|
Control.Monad.Apiary
- data ApiaryT c n m a
- type Apiary c = ApiaryT c IO Identity
- runApiary :: ApiaryConfig -> Apiary `[]` a -> Application
- runApiaryT :: (Monad n, Monad m) => (forall b. n b -> IO b) -> ApiaryConfig -> ApiaryT `[]` n m a -> m Application
- apiaryConfig :: Monad n => ApiaryT c n m ApiaryConfig
- action :: Monad n => Fn c (ActionT n ()) -> ApiaryT c n m ()
- action' :: Monad n => (SList c -> ActionT n ()) -> ApiaryT c n m ()
- group :: Text -> ApiaryT c n m a -> ApiaryT c n m a
- document :: Text -> ApiaryT c n m a -> ApiaryT c n m a
- precondition :: Html -> ApiaryT c n m a -> ApiaryT c n m a
- noDoc :: ApiaryT c n m a -> ApiaryT c n m a
- rpHtml :: Html -> Int -> Html
- actionWithPreAction :: Monad n => (SList xs -> ActionT n a) -> Fn xs (ActionT n ()) -> ApiaryT xs n m ()
Documentation
most generic Apiary monad. since 0.8.0.0.
Instances
| (Monad n, MonadBase b m) => MonadBase b (ApiaryT c n m) | |
| (Monad n, MonadBaseControl b m) => MonadBaseControl b (ApiaryT c n m) | |
| Monad n => MonadTrans (ApiaryT c n) | |
| Monad n => MonadTransControl (ApiaryT c n) | |
| Monad n => Monad (ApiaryT c n m) | |
| Functor (ApiaryT c n m) | |
| Monad n => Applicative (ApiaryT c n m) | |
| (Monad n, MonadIO m) => MonadIO (ApiaryT c n m) |
runApiary :: ApiaryConfig -> Apiary `[]` a -> ApplicationSource
runApiaryT :: (Monad n, Monad m) => (forall b. n b -> IO b) -> ApiaryConfig -> ApiaryT `[]` n m a -> m ApplicationSource
getter
apiaryConfig :: Monad n => ApiaryT c n m ApiaryConfigSource
execute action
action' :: Monad n => (SList c -> ActionT n ()) -> ApiaryT c n m ()Source
like action. but not apply arguments. since 0.8.0.0.
API documentation
group :: Text -> ApiaryT c n m a -> ApiaryT c n m aSource
API document group. since 0.12.0.0.
only top level group recognized.
document :: Text -> ApiaryT c n m a -> ApiaryT c n m aSource
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 c n m a -> ApiaryT c n m aSource
add user defined precondition. since 0.13.0.