Airship.Types

Documentation

data ETag

Constructors

Strong ByteString

Weak ByteString

Instances

Eq ETag

Ord ETag

Show ETag

data Webmachine m a

Instances

MonadTrans Webmachine

MonadBase b m => MonadBase b (Webmachine m)

MonadBaseControl b m => MonadBaseControl b (Webmachine m)

Monad m => MonadState ResponseState (Webmachine m)

Monad m => Monad (Webmachine m)

Monad m => Functor (Webmachine m)

Monad m => Applicative (Webmachine m)

MonadIO m => MonadIO (Webmachine m)

type StM (Webmachine m) a

data Request :: *

Information on the request sent by the client. This abstracts away the details of the underlying implementation.

Instances

Show Request

data Response

Constructors

Response

Fields

_responseStatus :: Status

_responseHeaders :: ResponseHeaders

_responseBody :: ResponseBody

data ResponseState

Constructors

ResponseState

Fields

stateHeaders :: ResponseHeaders

stateBody :: ResponseBody

_params :: HashMap Text Text

_dispatchPath :: [Text]

Instances

Monad m => MonadState ResponseState (Webmachine m)

data ResponseBody

Basically Wai's unexported Response type.

Constructors

ResponseFile FilePath (Maybe FilePart)

ResponseBuilder Builder

ResponseStream StreamingBody

Empty

defaultRequest :: Request

A default, blank request.

Since 2.0.0

entireRequestBody :: MonadIO m => Request -> m ByteString

Reads the entirety of the request body in a single string. This turns the chunks obtained from repeated invocations of requestBody into a lazy ByteString.

etagToByteString :: ETag -> ByteString

eitherResponse :: Monad m => UTCTime -> HashMap Text Text -> [Text] -> Request -> Webmachine m Response -> m (Response, Trace)

escapedResponse :: Text -> ResponseBody

Helper function for building a ResponseBuilder out of HTML-escaped text.

runWebmachine :: Monad m => UTCTime -> HashMap Text Text -> [Text] -> Request -> Webmachine m a -> m (Either Response a, Trace)

request :: Handler m Request

Returns the Request that this Handler is currently processing.

requestTime :: Handler m UTCTime

Returns the time at which this request began processing.

getResponseHeaders :: Handler m ResponseHeaders

Returns the ResponseHeaders stored in the current Handler.

getResponseBody :: Handler m ResponseBody

Returns the current ResponseBody that this Handler is storing.

params :: Handler m (HashMap Text Text)

Returns the bound routing parameters extracted from the routing system (see Airship.Route).

dispatchPath :: Handler m [Text]

putResponseBody :: ResponseBody -> Handler m ()

Given a new ResponseBody, replaces the stored body with the new one.

putResponseBS :: Monad m => ByteString -> Webmachine m ()

Stores the provided ByteString as the responseBody. This is a shortcut for creating a response body with a ResponseBuilder and a bytestring Builder.

halt :: Monad m => Status -> Webmachine m a

Immediately halts processing with the provided Status code. The contents of the Webmachine's response body will be streamed back to the client. This is a shortcut for constructing a Response with getResponseHeaders and getResponseBody and passing that response to finishWith.

finishWith :: Monad m => Response -> Webmachine m a

Immediately halts processing and writes the provided Response back to the client.

(#>) :: MonadWriter [(k, v)] m => k -> v -> m ()

The #> operator provides syntactic sugar for the construction of association lists. For example, the following assoc list:

    [("run", "jewels"), ("blue", "suede"), ("zion", "wolf")]

can be represented as such:

    execWriter $ do
      "run" #> "jewels"
      "blue" #> "suede"
      "zion" #> "wolf"

It used in RoutingSpec declarations to indicate that a particular Route maps to a given Resource, but can be used in many other places where association lists are expected, such as contentTypesProvided.