Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Core.Types.Http

Contents

types
responses
utils

Description

Core types and functions for HTTP

Synopsis

data Request = Request {
- path :: [Text]
- query :: QueryMap
- capture :: CaptureMap
- headers :: HeaderMap
- method :: Method
- readBody :: IO (Either Text ByteString)
- isSecure :: Bool
}
data Response = Response {
- status :: Status
- headers :: ResponseHeaders
- body :: ResponseBody
}
data ResponseBody
- = RawResp MediaType ByteString
- | FileResp FilePath
- | StreamResp
type HeaderMap = Map HeaderName ByteString
type QueryMap = Map ByteString (Maybe ByteString)
class ToText a where
- toText :: a -> Text
okResponse :: forall mime a. ToRespBody mime a => a -> Response
badResponse :: forall mime a. ToRespBody mime a => Status -> a -> Response
badRequest :: forall media a. ToRespBody media a => a -> Response
setContent :: MediaType -> ResponseHeaders
noContentResponse :: Status -> Response
setRespStatus :: Status -> Response -> Response
addRespHeaders :: ResponseHeaders -> Response -> Response
toFullPath :: Request -> Text

types

data Request Source #

Http request

Constructors

Request
Fields path :: [Text] URI path query :: QueryMap query parameters capture :: CaptureMap capture from path headers :: HeaderMap request headers method :: Method request method readBody :: IO (Either Text ByteString) lazy body reader. Error can happen if size is too big (configured on running the server) isSecure :: Bool was this request made over SSL connection

Instances

Instances details

MonadIO m => ToPlugin (PluginFun m) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: PluginFun m -> ServerFun (MonadOf (PluginFun m)) -> ServerFun (MonadOf (PluginFun m)) Source #

data Response Source #

Http response

Constructors

Response
Fields status :: Status status headers :: ResponseHeaders headers body :: ResponseBody response body

Instances

Instances details

Show Response Source #
Instance details Defined in Mig.Core.Types.Http Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
Eq Response Source #
Instance details Defined in Mig.Core.Types.Http Methods (==) :: Response -> Response -> Bool # (/=) :: Response -> Response -> Bool #
IsResp Response Source #
Instance details Defined in Mig.Core.Class.Response Associated Types type RespBody Response Source # type RespError Response Source # type RespMedia Response Source # Methods ok :: RespBody Response -> Response Source # bad :: Status -> RespError Response -> Response Source # noContent :: Status -> Response Source # addHeaders :: ResponseHeaders -> Response -> Response Source # getHeaders :: Response -> ResponseHeaders Source # setStatus :: Status -> Response -> Response Source # getRespBody :: Response -> Maybe (RespBody Response) Source # getRespError :: Response -> Maybe (RespError Response) Source # getStatus :: Response -> Status Source # setMedia :: MediaType -> Response -> Response Source # getMedia :: MediaType Source # toResponse :: Response -> Response Source #
MonadIO m => ToPlugin (PluginFun m) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: PluginFun m -> ServerFun (MonadOf (PluginFun m)) -> ServerFun (MonadOf (PluginFun m)) Source #
type RespBody Response Source #
Instance details Defined in Mig.Core.Class.Response type RespBody Response = ByteString
type RespError Response Source #
Instance details Defined in Mig.Core.Class.Response type RespError Response = ByteString
type RespMedia Response Source #
Instance details Defined in Mig.Core.Class.Response type RespMedia Response = AnyMedia

data ResponseBody Source #

Http response body

Constructors

RawResp MediaType ByteString
FileResp FilePath
StreamResp

Instances

Instances details

Show ResponseBody Source #
Instance details Defined in Mig.Core.Types.Http Methods showsPrec :: Int -> ResponseBody -> ShowS # show :: ResponseBody -> String # showList :: [ResponseBody] -> ShowS #
Eq ResponseBody Source #
Instance details Defined in Mig.Core.Types.Http Methods (==) :: ResponseBody -> ResponseBody -> Bool # (/=) :: ResponseBody -> ResponseBody -> Bool #

type HeaderMap = Map HeaderName ByteString Source #

Headers as map

type QueryMap = Map ByteString (Maybe ByteString) Source #

Map of query parameters for fast-access

class ToText a where Source #

Values convertible to lazy text

Methods

toText :: a -> Text Source #

Instances

Instances details

ToText Text Source #
Instance details Defined in Mig.Core.Types.Http Methods toText :: Text -> Text Source #
ToText Text Source #
Instance details Defined in Mig.Core.Types.Http Methods toText :: Text -> Text0 Source #
ToText String Source #
Instance details Defined in Mig.Core.Types.Http Methods toText :: String -> Text Source #
ToText Float Source #
Instance details Defined in Mig.Core.Types.Http Methods toText :: Float -> Text Source #
ToText Int Source #
Instance details Defined in Mig.Core.Types.Http Methods toText :: Int -> Text Source #

responses

okResponse :: forall mime a. ToRespBody mime a => a -> Response Source #

Respond with ok 200-status

badResponse :: forall mime a. ToRespBody mime a => Status -> a -> Response Source #

Bad response qith given status

badRequest :: forall media a. ToRespBody media a => a -> Response Source #

Bad request response

setContent :: MediaType -> ResponseHeaders Source #

Headers to set content type

noContentResponse :: Status -> Response Source #

Response with no content

utils

setRespStatus :: Status -> Response -> Response Source #

Sets response status

addRespHeaders :: ResponseHeaders -> Response -> Response Source #

toFullPath :: Request -> Text Source #