Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Core.Class.MediaType

Description

Classes for MediaType and proper converters of Http values fromto parameters or requestresponse bodies.

Synopsis

data MediaType
class ToMediaType a where
- toMediaType :: MediaType
class ToMediaType ty => ToRespBody ty b where
- toRespBody :: b -> ByteString
data Json
data FormUrlEncoded
data OctetStream
data AnyMedia
class ToMediaType ty => FromReqBody ty b where
- fromReqBody :: ByteString -> Either Text b

Documentation

data MediaType #

An HTTP media type, consisting of the type, subtype, and parameters.

Instances

Instances details

IsString MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods fromString :: String -> MediaType #
Show MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods showsPrec :: Int -> MediaType -> ShowS # show :: MediaType -> String # showList :: [MediaType] -> ShowS #
Eq MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods (==) :: MediaType -> MediaType -> Bool # (/=) :: MediaType -> MediaType -> Bool #
Ord MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods compare :: MediaType -> MediaType -> Ordering # (<) :: MediaType -> MediaType -> Bool # (<=) :: MediaType -> MediaType -> Bool # (>) :: MediaType -> MediaType -> Bool # (>=) :: MediaType -> MediaType -> Bool # max :: MediaType -> MediaType -> MediaType # min :: MediaType -> MediaType -> MediaType #
Accept MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods parseAccept :: ByteString -> Maybe MediaType # matches :: MediaType -> MediaType -> Bool # moreSpecificThan :: MediaType -> MediaType -> Bool # hasExtensionParameters :: Proxy MediaType -> Bool #
RenderHeader MediaType
Instance details Defined in Network.HTTP.Media.MediaType.Internal Methods renderHeader :: MediaType -> ByteString #
HasContentType Encoding (Maybe MediaType)
Instance details Defined in Data.OpenApi.Lens Methods contentType :: Lens' Encoding (Maybe MediaType) #
HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject)
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject) #
HasContent Response (InsOrdHashMap MediaType MediaTypeObject)
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject) #

class ToMediaType a where Source #

Conversion of type-level tags to media type values

Methods

toMediaType :: MediaType Source #

Instances

Instances details

ToMediaType Html Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType AnyMedia Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType FormUrlEncoded Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType Json Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType OctetStream Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToMediaType Text Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #

class ToMediaType ty => ToRespBody ty b where Source #

Values that can be rendered to response body byte string.

Methods

toRespBody :: b -> ByteString Source #

Instances

Instances details

ToMarkup a => ToRespBody Html a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: a -> ByteString Source #
ToRespBody AnyMedia ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString0 Source #
ToRespBody AnyMedia ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString Source #
ToForm a => ToRespBody FormUrlEncoded a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: a -> ByteString Source #
ToJSON a => ToRespBody Json a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: a -> ByteString Source #
ToRespBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString0 Source #
ToRespBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString Source #
ToRespBody Text Text Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: Text -> ByteString Source #
ToRespBody Text Text Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: Text -> ByteString Source #

data Json Source #

Type-level tag for JSON media type It is converted to "application/json"

Instances

Instances details

ToMediaType Json Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
FromJSON a => FromReqBody Json a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text a Source #
ToJSON a => ToRespBody Json a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: a -> ByteString Source #

data FormUrlEncoded Source #

Type-level tag for FORM url encoded media-type. It is converted to "application/x-www-form-urlencoded"

Instances

Instances details

ToMediaType FormUrlEncoded Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
FromForm a => FromReqBody FormUrlEncoded a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text a Source #
ToForm a => ToRespBody FormUrlEncoded a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: a -> ByteString Source #

data OctetStream Source #

Media type octet stream is for passing raw byte-strings in the request body. It is converted to "application/octet-stream"

Instances

Instances details

ToMediaType OctetStream Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
FromReqBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString0 -> Either Text ByteString Source #
FromReqBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text ByteString Source #
ToRespBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString0 Source #
ToRespBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString Source #

data AnyMedia Source #

Signifies any media. It prescribes the server renderer to lookup media-type at run-time in the "Conten-Type" header. As media-type it is rendered to "*/*".

It is useful for values for which we want to derive content type from run-time values. For example it is used for static file servers to get media type from file extension.

Instances

Instances details

ToMediaType AnyMedia Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toMediaType :: MediaType Source #
ToRespBody AnyMedia ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString0 Source #
ToRespBody AnyMedia ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods toRespBody :: ByteString -> ByteString Source #

class ToMediaType ty => FromReqBody ty b where Source #

Values that can be parsed from request byte string.

Methods

fromReqBody :: ByteString -> Either Text b Source #

Instances

Instances details

FromForm a => FromReqBody FormUrlEncoded a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text a Source #
FromJSON a => FromReqBody Json a Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text a Source #
FromReqBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString0 -> Either Text ByteString Source #
FromReqBody OctetStream ByteString Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text ByteString Source #
FromReqBody Text Text Source #
Instance details Defined in Mig.Core.Class.MediaType Methods fromReqBody :: ByteString -> Either Text Text Source #