Network.HTTP.Types

Case insensitive HTTP ByteStrings

data CIByteString

Case-insensitive HTTP ByteStrings, mostly for use in Header names.

Constructors

CIByteString

Fields

ciOriginal :: !ByteString

ciLowerCase :: !ByteString

Instances

Eq CIByteString

Ord CIByteString

Show CIByteString

IsString CIByteString

mkCIByteString :: ByteString -> CIByteString

Methods

type Method = ByteString

HTTP method (flat string type).

methodGet :: Method

methodPost :: Method

HTTP Method constants.

methodHead :: Method

methodPut :: Method

methodDelete :: Method

methodTrace :: Method

methodConnect :: Method

methodOptions :: Method

data StdMethod

HTTP standard method (as defined by RFC 2616).

Note that the Show instance is only for debugging and should NOT be used to generate HTTP method strings; use methodToByteString instead.

The constructor OtherMethod is not exported for forwards compatibility reasons.

Constructors

GET

POST

HEAD

PUT

DELETE

TRACE

CONNECT

OPTIONS

Instances

Bounded StdMethod

Enum StdMethod

Eq StdMethod

Ord StdMethod

Read StdMethod

Show StdMethod

Ix StdMethod

parseMethod :: Method -> Either ByteString StdMethod

Convert a method ByteString to a StdMethod if possible.

renderMethod :: Either ByteString StdMethod -> Method

Convert an algebraic method to a ByteString.

renderStdMethod :: StdMethod -> Method

Convert a StdMethod to a ByteString.

Versions

data HttpVersion

HTTP Version.

Note that the Show instance is intended merely for debugging.

Constructors

HttpVersion

Fields

httpMajor :: !Int

httpMinor :: !Int

Instances

Eq HttpVersion

Ord HttpVersion

Show HttpVersion

http09 :: HttpVersion

HTTP 0.9

http10 :: HttpVersion

HTTP 1.0

http11 :: HttpVersion

HTTP 1.1

Status

data Status

HTTP Status.

Only the statusCode is used for comparisons.

Note that the Show instance is only for debugging.

Constructors

Status

Fields

statusCode :: Int

statusMessage :: ByteString

Instances

Eq Status

Ord Status

Show Status

status200 :: Status

statusOK :: Status

OK

status201 :: Status

statusCreated :: Status

Created

status301 :: Status

statusMovedPermanently :: Status

Moved Permanently

status302 :: Status

statusFound :: Status

Found

status303 :: Status

statusSeeOther :: Status

See Other

status400 :: Status

statusBadRequest :: Status

Bad Request

status401 :: Status

statusUnauthorized :: Status

Unauthorized

status403 :: Status

statusForbidden :: Status

Forbidden

status404 :: Status

statusNotFound :: Status

Not Found

status405 :: Status

statusNotAllowed :: Status

Method Not Allowed

status500 :: Status

statusServerError :: Status

Internal Server Error

Headers

type Header = (CIByteString, ByteString)

Header

type RequestHeaders = [Header]

Request Headers

type ResponseHeaders = [Header]

Response Headers

headerAccept :: ByteString -> Header

headerCacheControl :: ByteString -> Header

HTTP Headers

headerConnection :: ByteString -> Header

headerContentLength :: ByteString -> Header

headerContentType :: ByteString -> Header

headerContentMD5 :: ByteString -> Header

headerDate :: ByteString -> Header

Query string

type QueryItem = (ByteString, Maybe ByteString)

Query item

type Query = [QueryItem]

Query.

General form: a=b&c=d, but if the value is Nothing, it becomes a&c=d.

type SimpleQueryItem = (ByteString, ByteString)

Simplified Query item type without support for parameter-less items.

type SimpleQuery = [SimpleQueryItem]

Simplified Query type without support for parameter-less items.

renderQuery :: Bool -> Query -> ByteString

Convert Query to ByteString.

renderSimpleQuery :: Bool -> SimpleQuery -> ByteString

Convert SimpleQuery to ByteString.

parseQuery :: ByteString -> Query

Parse Query from a ByteString.

parseSimpleQuery :: ByteString -> SimpleQuery

Parse SimpleQuery from a ByteString.

URL encoding / decoding

urlEncode :: ByteString -> ByteString

Percent-encoding for URLs.

urlDecode :: ByteString -> ByteString

Percent-decoding.