Control.Monad.Apiary.Action

Documentation

data ActionT exts m a

Instances

MonadBase b m => MonadBase b (ActionT exts m)

MonadBaseControl b m => MonadBaseControl b (ActionT exts m)

MonadReader r m => MonadReader r (ActionT exts m)

MonadTrans (ActionT exts)

MonadTransControl (ActionT exts)

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

Monad m => Monad (ActionT exts m)

Functor (ActionT exts m)

Monad m => MonadPlus (ActionT exts m)

Applicative (ActionT exts m)

MonadThrow m => MonadThrow (ActionT exts m)

MonadCatch m => MonadCatch (ActionT exts m)

MonadMask m => MonadMask (ActionT exts m)

MonadIO m => MonadIO (ActionT exts m)

data StT (ActionT exts) = StActionT {

• unStActionT :: Action a

}

data StM (ActionT exts m) = StMT {

• unStMT :: ComposeSt (ActionT exts) m a

}

data ApiaryConfig

Constructors

ApiaryConfig

Fields

notFound :: Application

call when no handler matched.

defaultStatus :: Status

used unless call status function.

defaultHeaders :: ResponseHeaders

initial headers.

failStatus :: Status

failHeaders :: ResponseHeaders

rootPattern :: [Text]

used by root filter.

mimeType :: FilePath -> ByteString

Instances

Default ApiaryConfig

defaultDocumentationAction :: Monad m => DefaultDocumentConfig -> ActionT exts m ()

data DefaultDocumentConfig

Constructors

DefaultDocumentConfig

Fields

documentTitle :: Text

documentDescription :: Maybe Html

documentUseCDN :: Bool

documentGoogleAnalytics :: Maybe Text

google analytics. since 0.17.0.

Instances

Default DefaultDocumentConfig

actions

stop :: Monad m => ActionT exts m a

stop handler and send current state. since 0.3.3.0.

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

stop with response. since 0.4.2.0.

getter

getRequest :: Monad m => ActionT exts m Request

get raw request. since 0.1.0.0.

getHeaders :: Monad m => ActionT exts m RequestHeaders

get all request headers. since 0.6.0.0.

getReqParams :: MonadIO m => ActionT exts m [Param]

parse request body and return params. since 0.9.0.0.

data File

Constructors

File

Fields

fileParameter :: ByteString

fileName :: ByteString

fileContentType :: ByteString

fileContent :: ByteString

Instances

Eq File

Show File

ReqParam File

Typeable * File

getReqFiles :: MonadIO m => ActionT exts m [File]

parse request body and return files. since 0.9.0.0.

getExt :: (Has e exts, Monad m) => proxy e -> ActionT exts m e

setter

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

set status code. since 0.1.0.0.

response header

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

add response header. since 0.1.0.0.

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

set response headers. since 0.1.0.0.

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

modify response header. since 0.1.0.0.

type ContentType = ByteString

contentType :: Monad m => ContentType -> ActionT exts m ()

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

response body

reset :: Monad m => ActionT exts m ()

reset response body to no response. since v0.15.2.

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

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

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

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

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

append response body from builder. since 0.1.0.0.

bytes :: Monad m => ByteString -> ActionT exts m ()

append response body from strict bytestring. since 0.15.2.

lazyBytes :: Monad m => ByteString -> ActionT exts m ()

append response body from lazy bytestring. since 0.15.2.

text :: Monad m => Text -> ActionT exts m ()

append response body from strict text. encoding UTF-8. since 0.15.2.

lazyText :: Monad m => Text -> ActionT exts m ()

append response body from lazy text. encoding UTF-8. since 0.15.2.

showing :: (Monad m, Show a) => a -> ActionT exts m ()

append response body from show. encoding UTF-8. since 0.15.2.

string :: Monad m => String -> ActionT exts m ()

append response body from string. encoding UTF-8. since 0.15.2.

char :: Monad m => Char -> ActionT exts m ()

append response body from char. encoding UTF-8. since 0.15.2.

stream :: Monad m => StreamingBody -> ActionT exts m ()

set response body source. since 0.9.0.0.

rawResponse :: Monad m => (Status -> ResponseHeaders -> Response) -> ActionT exts m ()

set raw response constructor. since 0.10.

example(use pipes-wai)

producer :: Monad m => Producer (Flush Builder) IO () -> ActionT exts m ()
producer = response (s h -> responseProducer s h)

type StreamingBody = (Builder -> IO ()) -> IO () -> IO ()

Represents a streaming HTTP response body. It's a function of two parameters; the first parameter provides a means of sending another chunk of data, and the second parameter provides a means of flushing the data to the client.

Since 3.0.0

monolithic action

redirect

redirect :: Monad m => ByteString -> ActionT exts m ()

redirect with:

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

since 0.6.2.0.

redirectPermanently :: Monad m => ByteString -> ActionT exts m ()

redirect with 301 Moved Permanently. since 0.3.3.0.

redirectTemporary :: Monad m => ByteString -> ActionT exts m ()

redirect with:

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

since 0.3.3.0.

redirectWith

Arguments

:: Monad m

=> Status

-> ByteString

Location redirect to

-> ActionT exts m ()

redirect handler

set status and add location header. since 0.3.3.0.

rename from redirect in 0.6.2.0.

deprecated

redirectFound :: Monad m => ByteString -> ActionT exts m ()

Deprecated: use redirect

redirect with 302 Found. since 0.3.3.0.

redirectSeeOther :: Monad m => ByteString -> ActionT exts m ()

Deprecated: use redirect

redirect with 303 See Other. since 0.3.3.0.

source :: Monad m => StreamingBody -> ActionT exts m ()

Deprecated: use stream

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

Deprecated: use lazyBytes

append response body from lazy bytestring. since 0.1.0.0.