Network.Monad.HTTP.Header

Provide the functionality of Network.HTTP.Headers with qualified identifier style.

Documentation

class HasHeaders x where

HasHeaders is a type class for types containing HTTP headers, allowing you to write overloaded header manipulation functions for both Request and Response data types, for instance.

Minimal complete definition

getHeaders, setHeaders

Methods

getHeaders :: x -> [Header]

setHeaders :: x -> [Header] -> x

Instances

HasHeaders (Request a)

Methods

getHeaders :: Request a -> [Header]

setHeaders :: Request a -> [Header] -> Request a

HasHeaders (Response a)

Methods

getHeaders :: Response a -> [Header]

setHeaders :: Response a -> [Header] -> Response a

type T = Header

data Header :: *

The Header data type pairs header names & values.

Constructors

Header HeaderName String

Instances

Show Header

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

cons :: Name -> String -> T

type Name = HeaderName

data HeaderName :: *

HTTP HeaderName type, a Haskell data constructor for each specification-defined header, prefixed with Hdr and CamelCased, (i.e., eliding the - in the process.) Should you require using a custom header, there's the HdrCustom constructor which takes a String argument.

Encoding HTTP header names differently, as Strings perhaps, is an equally fine choice..no decidedly clear winner, but let's stick with data constructors here.

Constructors

HdrCacheControl

HdrConnection

HdrDate

HdrPragma

HdrTransferEncoding

HdrUpgrade

HdrVia

HdrAccept

HdrAcceptCharset

HdrAcceptEncoding

HdrAcceptLanguage

HdrAuthorization

HdrCookie

HdrExpect

HdrFrom

HdrHost

HdrIfModifiedSince

HdrIfMatch

HdrIfNoneMatch

HdrIfRange

HdrIfUnmodifiedSince

HdrMaxForwards

HdrProxyAuthorization

HdrRange

HdrReferer

HdrUserAgent

HdrAge

HdrLocation

HdrProxyAuthenticate

HdrPublic

HdrRetryAfter

HdrServer

HdrSetCookie

HdrTE

HdrTrailer

HdrVary

HdrWarning

HdrWWWAuthenticate

HdrAllow

HdrContentBase

HdrContentEncoding

HdrContentLanguage

HdrContentLength

HdrContentLocation

HdrContentMD5

HdrContentRange

HdrContentType

HdrETag

HdrExpires

HdrLastModified

HdrContentTransferEncoding

MIME entity headers (for sub-parts)

HdrCustom String

Allows for unrecognised or experimental headers.

Instances

Eq HeaderName

Methods

(==) :: HeaderName -> HeaderName -> Bool

(/=) :: HeaderName -> HeaderName -> Bool

Show HeaderName

Methods

showsPrec :: Int -> HeaderName -> ShowS

show :: HeaderName -> String

showList :: [HeaderName] -> ShowS

consName :: String -> Name

getName :: T -> Name

getValue :: T -> String

setMany :: HasHeaders x => x -> [T] -> x

getMany :: HasHeaders x => x -> [T]

modifyMany :: HasHeaders x => ([T] -> [T]) -> x -> x

insert :: HasHeaders a => Name -> String -> a -> a

Inserts a header with the given name and value. Allows duplicate header names.

insertMany :: HasHeaders a => [T] -> a -> a

Inserts multiple headers.

insertIfMissing :: HasHeaders a => Name -> String -> a -> a

Adds the new header only if no previous header shares the same name.

retrieveMany :: HasHeaders a => Name -> a -> [T]

Gets a list of headers with a particular Name.

replace :: HasHeaders a => Name -> String -> a -> a

Removes old headers with duplicate name.

find :: HasHeaders a => Name -> a -> Maybe String

Lookup presence of specific Name in a list of Headers Returns the value from the first matching header.

findMany :: HasHeaders a => Name -> a -> [String]

lookup :: Name -> [T] -> Maybe String

Deprecated: Call find using the [Header] instance of HasHeaders

parse :: String -> Exceptional String T

parseManyWarn :: [String] -> [Exceptional String T]

parseManyStraight :: [String] -> [T]

dictionary :: Map String Name

matchName :: Name -> T -> Bool