Control.Monad.Apiary.Action

Documentation

data Action a

Instances

Monad Action

Functor Action

MonadPlus Action

Applicative Action

Alternative Action

MonadIO Action

MonadBase IO Action

MonadBaseControl IO Action

Monoid (Action ())

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 :: Action a

stop handler and send current state. since 0.3.3.0.

stopWith :: Response -> Action a

stop with response. since 0.4.2.0.

getter

getRequest :: Action Request

get raw request. since 0.1.0.0.

getHeaders :: Action RequestHeaders

get all request headers. since 0.6.0.0.

setter

status :: Status -> Action ()

set status code. since 0.1.0.0.

response header

addHeader :: HeaderName -> ByteString -> Action ()

add response header. since 0.1.0.0.

setHeaders :: ResponseHeaders -> Action ()

set response headers. since 0.1.0.0.

modifyHeader :: (ResponseHeaders -> ResponseHeaders) -> Action ()

modify response header. since 0.1.0.0.

contentType :: ByteString -> Action ()

set content-type header. if content-type header already exists, replace it. since 0.1.0.0.

response body

file :: FilePath -> Maybe FilePart -> Action ()

set response body file content and detect Content-Type by extension. since 0.1.0.0.

file' :: FilePath -> Maybe FilePart -> Action ()

set response body file content, without set Content-Type. since 0.1.0.0.

builder :: Builder -> Action ()

set response body builder. since 0.1.0.0.

lbs :: ByteString -> Action ()

set response body lazy bytestring. since 0.1.0.0.

source :: Source IO (Flush Builder) -> Action ()

set response body source. since 0.1.0.0.

monolithic action

redirect

redirect :: ByteString -> Action ()

redirect with:

303 See Other (HTTP/1.1) or 302 Moved Temporarily (Other)

since 0.6.2.0.

redirectPermanently :: ByteString -> Action ()

redirect with 301 Moved Permanently. since 0.3.3.0.

redirectTemporary :: ByteString -> Action ()

redirect with:

307 Temporary Redirect (HTTP/1.1) or 302 Moved Temporarily (Other)

since 0.3.3.0.

redirectWith

Arguments

:: Status

-> ByteString

Location redirect to

-> Action ()

redirect handler

set status, add location header. since 0.3.3.0.

rename from redirect in 0.6.2.0.

Reexport

module Data.Default.Class

deprecated

redirectFound :: ByteString -> Action ()

Deprecated: use redirect

redirect with 302 Found. since 0.3.3.0.

redirectSeeOther :: ByteString -> Action ()

Deprecated: use redirect

redirect with 303 See Other. since 0.3.3.0.