Safe Haskell	None

Control.Monad.Apiary.Action

Contents

actions
deprecated

Synopsis

Documentation

data ActionT exts m a Source

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 => Monad (ActionT exts m)
Functor (ActionT exts m)
Monad m => MonadPlus (ActionT exts m)
Applicative (ActionT exts m)
(Monad m, Functor m) => Alternative (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 ApiaryConfig Source

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 ()Source

data DefaultDocumentConfig Source

Constructors

DefaultDocumentConfig
Fields documentTitle :: Text documentDescription :: Maybe Html documentUseCDN :: Bool

Instances

Default DefaultDocumentConfig

actions

stop :: Monad m => ActionT exts m aSource

stop handler and send current state. since 0.3.3.0.

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

stop with response. since 0.4.2.0.

getter

getRequest :: Monad m => ActionT exts m Request Source

get raw request. since 0.1.0.0.

getHeaders :: Monad m => ActionT exts m RequestHeaders Source

get all request headers. since 0.6.0.0.

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

parse request body and return params. since 0.9.0.0.

data File Source

Constructors

File
Fields fileParameter :: ByteString fileName :: ByteString fileContentType :: ByteString fileContent :: ByteString

Instances

Eq File
Show File
Typeable File
ReqParam File

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

parse request body and return files. since 0.9.0.0.

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

setter

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

set status code. since 0.1.0.0.

response header

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

add response header. since 0.1.0.0.

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

set response headers. since 0.1.0.0.

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

modify response header. since 0.1.0.0.

type ContentType = ByteString Source

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

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 ()Source

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

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

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 ()Source

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

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

append response body from builder. since 0.1.0.0.

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

append response body from strict bytestring. since 0.15.2.

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

append response body from lazy bytestring. since 0.15.2.

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

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

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

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

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

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

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

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

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

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

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

set response body source. since 0.9.0.0.

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

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