http-media-0.7.1: Processing HTTP Content-Type and Accept headers

Safe Haskell | Safe
Language | Haskell2010

Network.HTTP.Media.MediaType

Contents

- Type and creation
- Querying

Description

Defines the `MediaType` accept header with an `Accept` instance for use in content-type negotiation.

Synopsis

- data MediaType
- type Parameters = Map (CI ByteString) (CI ByteString)
- (//) :: ByteString -> ByteString -> MediaType
- (/:) :: MediaType -> (ByteString, ByteString) -> MediaType
- mainType :: MediaType -> CI ByteString
- subType :: MediaType -> CI ByteString
- parameters :: MediaType -> Parameters
- (/?) :: MediaType -> ByteString -> Bool
- (/.) :: MediaType -> ByteString -> Maybe (CI ByteString)

# Type and creation

data MediaType #

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

Instances

Eq MediaType # |
Methods (==) :: MediaType -> MediaType -> Bool # (/=) :: MediaType -> MediaType -> Bool #
Ord MediaType # |
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 #
Show MediaType # |
Methods showsPrec :: Int -> MediaType -> ShowS # show :: MediaType -> String # showList :: [MediaType] -> ShowS #
IsString MediaType # |
Methods fromString :: String -> MediaType #
RenderHeader MediaType # |
Methods renderHeader :: MediaType -> ByteString #
Accept MediaType # |
Methods parseAccept :: ByteString -> Maybe MediaType # matches :: MediaType -> MediaType -> Bool # moreSpecificThan :: MediaType -> MediaType -> Bool # hasExtensionParameters :: Proxy * MediaType -> Bool #

type Parameters = Map (CI ByteString) (CI ByteString) #

`MediaType` parameters.

(//) :: ByteString -> ByteString -> MediaType #

Builds a `MediaType` without parameters. Can produce an error if either type is invalid.

(/:) :: MediaType -> (ByteString, ByteString) -> MediaType #

Adds a parameter to a `MediaType`. Can produce an error if either string is invalid.

# Querying

mainType :: MediaType -> CI ByteString #

Retrieves the main type of a `MediaType`.

subType :: MediaType -> CI ByteString #

Retrieves the sub type of a `MediaType`.

parameters :: MediaType -> Parameters #

Retrieves the parameters of a `MediaType`.

(/?) :: MediaType -> ByteString -> Bool #

Evaluates if a `MediaType` has a parameter of the given name.

(/.) :: MediaType -> ByteString -> Maybe (CI ByteString) #

Retrieves a parameter from a `MediaType`.