Control.Monad.Apiary.Action

Documentation

data ActionT m a

Instances

MonadTrans ActionT

MonadTransControl ActionT

MonadBase b m => MonadBase b (ActionT m)

MonadBaseControl b m => MonadBaseControl b (ActionT m)

MonadReader r m => MonadReader r (ActionT m)

Monad m => Monad (ActionT m)

Functor (ActionT m)

Monad m => MonadPlus (ActionT m)

Applicative (ActionT m)

(Monad m, Functor m) => Alternative (ActionT m)

MonadLogger m => MonadLogger (ActionT m)

MonadIO m => MonadIO (ActionT m)

Monad m => Monoid (ActionT m ())

data ApiaryConfig

Constructors

ApiaryConfig

Fields

notFound :: Application

call when no handler matched.

defaultStatus :: Status

used unless call status function.

defaultHeader :: ResponseHeaders

initial headers.

rootPattern :: [ByteString]

used by root filter.

mimeType :: FilePath -> ByteString

Instances

Default ApiaryConfig

actions

stop :: Monad m => ActionT m a

stop handler and send current state. since 0.3.3.0.

stopWith :: Monad m => Response -> ActionT m a

stop with response. since 0.4.2.0.

getter

getRequest :: Monad m => ActionT m Request

getQuery :: Monad m => ByteString -> ActionT m (Maybe (Maybe ByteString))

Deprecated: use qeury derived filter.

getQuery' :: Monad m => ByteString -> ActionT m (Maybe ByteString)

Deprecated: use qeury derived filter.

when query parameter is not found, mzero(pass next handler).

getRequestHeader :: Monad m => HeaderName -> ActionT m (Maybe ByteString)

getRequestHeader' :: Monad m => HeaderName -> ActionT m ByteString

when request header is not found, mzero(pass next handler).

setter

status :: Monad m => Status -> ActionT m ()

response header

addHeader :: Monad m => HeaderName -> ByteString -> ActionT m ()

setHeaders :: Monad m => ResponseHeaders -> ActionT m ()

modifyHeader :: Monad m => (ResponseHeaders -> ResponseHeaders) -> ActionT m ()

contentType :: Monad m => ByteString -> ActionT m ()

response body

file :: Monad m => FilePath -> Maybe FilePart -> ActionT m ()

set body to file content and detect Content-Type by extension.

file' :: Monad m => FilePath -> Maybe FilePart -> ActionT m ()

builder :: Monad m => Builder -> ActionT m ()

lbs :: Monad m => ByteString -> ActionT m ()

source :: Monad m => Source IO (Flush Builder) -> ActionT m ()

monolithic action

redirect

redirect

Arguments

:: Monad m

=> Status

-> ByteString

Location redirect to

-> ActionT m a

redirect handler

set status, location header and stop. since 0.3.3.0.

redirectPermanently :: Monad m => ByteString -> ActionT m a

redirect with 301 Moved Permanently. since 0.3.3.0.

redirectFound :: Monad m => ByteString -> ActionT m a

redirect with 302 Found. since 0.3.3.0.

redirectSeeOther :: Monad m => ByteString -> ActionT m a

redirect with 303 See Other. since 0.3.3.0.

redirectTemporary :: Monad m => ByteString -> ActionT m a

redirect with 307 Temporary Redirect. since 0.3.3.0.

Reexport

module Data.Default.Class