Web.Respond.Response

utilities and defaults for sending responses.

headers

findHeader :: MonadRespond m => HeaderName -> m (Maybe ByteString)

findHeaderDefault :: MonadRespond m => HeaderName -> ByteString -> m ByteString

getAcceptHeader :: MonadRespond m => m ByteString

get the value of the Accept header, falling back to "*/*" if it was not sent in the request

constructing responses

respondEmptyBody :: MonadRespond m => Status -> ResponseHeaders -> m ResponseReceived

responding with an empty body means not having to worry about the Accept header.

respondUsingBody :: MonadRespond m => Status -> ResponseHeaders -> ResponseBody -> m ResponseReceived

respond by getting the information from a ResponseBody

respondWith :: (MonadRespond m, ToResponseBody a) => Status -> ResponseHeaders -> a -> m ResponseReceived

respond by using the ToResponseBody instance for the value and determining if it can be converted into an acceptable response body.

calls handleUnacceptableResponse if an acceptable content type cannot be produced..

respondStdHeaders :: (MonadRespond m, ToResponseBody a) => Status -> a -> m ResponseReceived

respond with no additional headers

respondOk :: (MonadRespond m, ToResponseBody a) => a -> m ResponseReceived

respond with 200 Ok

respondReportError :: (MonadRespond m, ReportableError e) => Status -> ResponseHeaders -> e -> m ResponseReceived

respond using a ReportableError to generate the response body.

respondNotFound :: (MonadRespond m, ReportableError e) => e -> m ResponseReceived

respond that something was not found

use the RequestErrorHandlers

handleUnsupportedMethod :: MonadRespond m => [StdMethod] -> Method -> m ResponseReceived

an action that gets the currently installed unsupported method handler and applies it to the arguments

handleUnmatchedPath :: MonadRespond m => m ResponseReceived

an action that gets the installed unmatched path handler and uses it

handleUnacceptableResponse :: MonadRespond m => m ResponseReceived

get and use handler for unacceptable response types

useHandlerForReport

Arguments

:: (MonadRespond m, ReportableError e)

=> (FailureHandlers -> e -> m ResponseReceived)

a handler-getter that gets a handler that takes an error report

-> e

the error

-> m ResponseReceived

generic handler-getter for things that use ErrorReports

handleBodyParseFailure :: (MonadRespond m, ReportableError e) => e -> m ResponseReceived

an action that gets the installed body parse failure handler and applies it

handleAuthFailed :: (MonadRespond m, ReportableError e) => e -> m ResponseReceived

get and use installed auth failed handler

handleAccessDenied :: (ReportableError e, MonadRespond m) => e -> m ResponseReceived

get and use access denied handler

handleCaughtException :: (ReportableError e, MonadRespond m) => e -> m ResponseReceived

get and use handler for caught exceptions.

getHandler :: MonadRespond m => (FailureHandlers -> a) -> m a

get a specific handler.

getHandler = (<$> getHandlers)

other response utilities.

maybeNotFound :: (ReportableError e, MonadRespond m) => e -> (a -> m ResponseReceived) -> Maybe a -> m ResponseReceived

a way to use Maybe values to produce 404s

catchRespond :: (MonadCatch m, MonadRespond m, ReportableError r, Exception e) => (e -> r) -> m ResponseReceived -> m ResponseReceived

catch Exceptions using MonadCatch, and use handleCaughtException to respond with an error report.