Mig.Core.ServerFun

Low-level server representarion. The server is a function from Request to Response.

type ServerFun m = Request -> m (Maybe Response)

To use the mig library with some server library like wai/warp we need to provide conversion of type ServerFun to the representarion of the given library. We can convert mig server to ServerFun with function fromServer. The Maybe type in the result encodes missing routes.

Documentation

type ServerFun m = Request -> m (Maybe Response)

Low-level representation of the server. Missing route for a given request returns Nothing.

sendResponse :: Functor m => m Response -> ServerFun m

Runs response getter action and returns it for any input request

withBody :: forall media a m. (MonadIO m, FromReqBody media a) => (a -> ServerFun m) -> ServerFun m

Reads request body.

withRawBody :: MonadIO m => (ByteString -> ServerFun m) -> ServerFun m

Reads low-level request body as byte string

withQuery :: (Monad m, FromHttpApiData a) => Text -> (a -> ServerFun m) -> ServerFun m

Reads required query parameter

withQueryFlag :: Text -> (Bool -> ServerFun m) -> ServerFun m

Reads query flag

withOptional :: FromHttpApiData a => Text -> (Maybe a -> ServerFun m) -> ServerFun m

reads optional query parameter

withCapture :: (Monad m, FromHttpApiData a) => Text -> (a -> ServerFun m) -> ServerFun m

Reads capture from the path

withHeader :: (Monad m, FromHttpApiData a) => HeaderName -> (a -> ServerFun m) -> ServerFun m

reads request header

withOptionalHeader :: FromHttpApiData a => HeaderName -> (Maybe a -> ServerFun m) -> ServerFun m

Reads optional request header

withCookie :: forall a m. FromForm a => (Maybe a -> ServerFun m) -> ServerFun m

withPathInfo :: ([Text] -> ServerFun m) -> ServerFun m

Reads full path (without qury parameters)

withFullPathInfo :: (Text -> ServerFun m) -> ServerFun m

Reads full path (without qury parameters)

handleServerError :: (Exception a, MonadCatch m) => (a -> ServerFun m) -> ServerFun m -> ServerFun m

Handle errors