Mig.Core.Class.Response

Generic response

Documentation

data Resp (media :: Type) a

Response with info on the media-type encoded as type.

Constructors

Resp

Fields

• status :: Status

  response status

• headers :: ResponseHeaders

  response headers

• body :: Maybe a

  response body. Nothing means "no content" in the body

Instances

Functor (Resp media)

Defined in Mig.Core.Class.Response

Methods

fmap :: (a -> b) -> Resp media a -> Resp media b

(<$) :: a -> Resp media b -> Resp media a

Show a => Show (Resp media a)

Defined in Mig.Core.Class.Response

Methods

showsPrec :: Int -> Resp media a -> ShowS

show :: Resp media a -> String

showList :: [Resp media a] -> ShowS

Eq a => Eq (Resp media a)

Defined in Mig.Core.Class.Response

Methods

(==) :: Resp media a -> Resp media a -> Bool

(/=) :: Resp media a -> Resp media a -> Bool

ToRespBody ty a => IsResp (Resp ty a)

Defined in Mig.Core.Class.Response

Associated Types

type RespBody (Resp ty a)

type RespError (Resp ty a)

type RespMedia (Resp ty a)

Methods

ok :: RespBody (Resp ty a) -> Resp ty a

bad :: Status -> RespError (Resp ty a) -> Resp ty a

noContent :: Status -> Resp ty a

addHeaders :: ResponseHeaders -> Resp ty a -> Resp ty a

getHeaders :: Resp ty a -> ResponseHeaders

setStatus :: Status -> Resp ty a -> Resp ty a

getRespBody :: Resp ty a -> Maybe (RespBody (Resp ty a))

getRespError :: Resp ty a -> Maybe (RespError (Resp ty a))

getStatus :: Resp ty a -> Status

setMedia :: MediaType -> Resp ty a -> Resp ty a

getMedia :: MediaType

toResponse :: Resp ty a -> Response

type RespBody (Resp ty a)

Defined in Mig.Core.Class.Response

type RespBody (Resp ty a) = a

type RespError (Resp ty a)

Defined in Mig.Core.Class.Response

type RespError (Resp ty a) = a

type RespMedia (Resp ty a)

Defined in Mig.Core.Class.Response

type RespMedia (Resp ty a) = ty

newtype RespOr ty err a

Response that can contain an error. The error is represented with left case of an Either-type.

Constructors

RespOr

Fields

• unRespOr :: Either (Resp ty err) (Resp ty a)

Instances

Functor (RespOr ty err)

Defined in Mig.Core.Class.Response

Methods

fmap :: (a -> b) -> RespOr ty err a -> RespOr ty err b

(<$) :: a -> RespOr ty err b -> RespOr ty err a

(Show err, Show a) => Show (RespOr ty err a)

Defined in Mig.Core.Class.Response

Methods

showsPrec :: Int -> RespOr ty err a -> ShowS

show :: RespOr ty err a -> String

showList :: [RespOr ty err a] -> ShowS

(Eq err, Eq a) => Eq (RespOr ty err a)

Defined in Mig.Core.Class.Response

Methods

(==) :: RespOr ty err a -> RespOr ty err a -> Bool

(/=) :: RespOr ty err a -> RespOr ty err a -> Bool

(ToRespBody ty err, ToRespBody ty a) => IsResp (RespOr ty err a)

Defined in Mig.Core.Class.Response

Associated Types

type RespBody (RespOr ty err a)

type RespError (RespOr ty err a)

type RespMedia (RespOr ty err a)

Methods

ok :: RespBody (RespOr ty err a) -> RespOr ty err a

bad :: Status -> RespError (RespOr ty err a) -> RespOr ty err a

noContent :: Status -> RespOr ty err a

addHeaders :: ResponseHeaders -> RespOr ty err a -> RespOr ty err a

getHeaders :: RespOr ty err a -> ResponseHeaders

setStatus :: Status -> RespOr ty err a -> RespOr ty err a

getRespBody :: RespOr ty err a -> Maybe (RespBody (RespOr ty err a))

getRespError :: RespOr ty err a -> Maybe (RespError (RespOr ty err a))

getStatus :: RespOr ty err a -> Status

setMedia :: MediaType -> RespOr ty err a -> RespOr ty err a

getMedia :: MediaType

toResponse :: RespOr ty err a -> Response

type RespBody (RespOr ty err a)

Defined in Mig.Core.Class.Response

type RespBody (RespOr ty err a) = a

type RespError (RespOr ty err a)

Defined in Mig.Core.Class.Response

type RespError (RespOr ty err a) = err

type RespMedia (RespOr ty err a)

Defined in Mig.Core.Class.Response

type RespMedia (RespOr ty err a) = ty

class IsResp a where

Values that can be converted to low-level response.

The repsonse value is usually one of two cases:

• Resp a -- for routes which always produce a value
• RespOr err a - for routes that can also produce an error or value.
• Response - low-level HTTP-response.

Minimal complete definition

ok, bad, noContent, addHeaders, getHeaders, setStatus, getRespBody, getRespError, getStatus, getMedia, toResponse

Associated Types

type RespBody a :: Type

the type of response body value

type RespError a :: Type

the type of an error

type RespMedia a :: Type

the media tpye of resp

Methods

ok :: RespBody a -> a

Returns valid repsonse with 200 status

bad :: Status -> RespError a -> a

Returns an error with given status

noContent :: Status -> a

response with no content

addHeaders :: ResponseHeaders -> a -> a

Add some header to the response

getHeaders :: a -> ResponseHeaders

Get response headers

setStatus :: Status -> a -> a

Sets repsonse status

getRespBody :: a -> Maybe (RespBody a)

Get response body

getRespError :: a -> Maybe (RespError a)

Get response error

getStatus :: a -> Status

Get response status

setMedia :: MediaType -> a -> a

Set the media type of the response

getMedia :: MediaType

Reads the media type by response type

toResponse :: a -> Response

Converts value to low-level response

Instances

IsResp Response

Defined in Mig.Core.Class.Response

Associated Types

type RespBody Response

type RespError Response

type RespMedia Response

Methods

ok :: RespBody Response -> Response

bad :: Status -> RespError Response -> Response

noContent :: Status -> Response

addHeaders :: ResponseHeaders -> Response -> Response

getHeaders :: Response -> ResponseHeaders

setStatus :: Status -> Response -> Response

getRespBody :: Response -> Maybe (RespBody Response)

getRespError :: Response -> Maybe (RespError Response)

getStatus :: Response -> Status

setMedia :: MediaType -> Response -> Response

getMedia :: MediaType

toResponse :: Response -> Response

ToRespBody ty a => IsResp (Resp ty a)

Defined in Mig.Core.Class.Response

Associated Types

type RespBody (Resp ty a)

type RespError (Resp ty a)

type RespMedia (Resp ty a)

Methods

ok :: RespBody (Resp ty a) -> Resp ty a

bad :: Status -> RespError (Resp ty a) -> Resp ty a

noContent :: Status -> Resp ty a

addHeaders :: ResponseHeaders -> Resp ty a -> Resp ty a

getHeaders :: Resp ty a -> ResponseHeaders

setStatus :: Status -> Resp ty a -> Resp ty a

getRespBody :: Resp ty a -> Maybe (RespBody (Resp ty a))

getRespError :: Resp ty a -> Maybe (RespError (Resp ty a))

getStatus :: Resp ty a -> Status

setMedia :: MediaType -> Resp ty a -> Resp ty a

getMedia :: MediaType

toResponse :: Resp ty a -> Response

(ToRespBody ty err, ToRespBody ty a) => IsResp (RespOr ty err a)

Defined in Mig.Core.Class.Response

Associated Types

type RespBody (RespOr ty err a)

type RespError (RespOr ty err a)

type RespMedia (RespOr ty err a)

Methods

ok :: RespBody (RespOr ty err a) -> RespOr ty err a

bad :: Status -> RespError (RespOr ty err a) -> RespOr ty err a

noContent :: Status -> RespOr ty err a

addHeaders :: ResponseHeaders -> RespOr ty err a -> RespOr ty err a

getHeaders :: RespOr ty err a -> ResponseHeaders

setStatus :: Status -> RespOr ty err a -> RespOr ty err a

getRespBody :: RespOr ty err a -> Maybe (RespBody (RespOr ty err a))

getRespError :: RespOr ty err a -> Maybe (RespError (RespOr ty err a))

getStatus :: RespOr ty err a -> Status

setMedia :: MediaType -> RespOr ty err a -> RespOr ty err a

getMedia :: MediaType

toResponse :: RespOr ty err a -> Response

badReq :: IsResp a => RespError a -> a

Bad request. The bad response with 400 status.

internalServerError :: IsResp a => RespError a -> a

Internal server error. The bad response with 500 status.

notImplemented :: IsResp a => RespError a -> a

Not implemented route. The bad response with 501 status.

redirect :: IsResp a => Text -> a

Redirect to url. It is bad response with 302 status and set header of Location to a given URL.

setHeader :: (IsResp a, ToHttpApiData h) => HeaderName -> h -> a -> a

Set header for response

data SetCookie a

Set cookie params. For explanation see an article https://web.archive.org/web/20170122122852/https://www.nczonline.net/blog/2009/05/05/http-cookies-explained/

Constructors

SetCookie

Fields

• cookie :: a
• expires :: Maybe UTCTime
• domain :: Maybe Text
• path :: Maybe Text
• secure :: Bool
• httpOnly :: Bool

Instances

Show a => Show (SetCookie a)

Defined in Mig.Core.Class.Response

Methods

showsPrec :: Int -> SetCookie a -> ShowS

show :: SetCookie a -> String

showList :: [SetCookie a] -> ShowS

Eq a => Eq (SetCookie a)

Defined in Mig.Core.Class.Response

Methods

(==) :: SetCookie a -> SetCookie a -> Bool

(/=) :: SetCookie a -> SetCookie a -> Bool

defCookie :: a -> SetCookie a

Default cookie which sets only the cookie itself.

setCookie :: (ToForm cookie, IsResp resp) => SetCookie cookie -> resp -> resp

Set cookie as http header from form url encoded value