http-types-0.12.1: Generic HTTP types for Haskell (for both client and server code).

Safe HaskellSafe
LanguageHaskell98

Network.HTTP.Types

Contents

Synopsis

Methods

type Method = ByteString Source #

HTTP method (flat string type).

methodGet :: Method Source #

HTTP Method constants.

methodPost :: Method Source #

HTTP Method constants.

methodHead :: Method Source #

HTTP Method constants.

methodPut :: Method Source #

HTTP Method constants.

methodDelete :: Method Source #

HTTP Method constants.

methodTrace :: Method Source #

HTTP Method constants.

methodConnect :: Method Source #

HTTP Method constants.

methodOptions :: Method Source #

HTTP Method constants.

methodPatch :: Method Source #

HTTP Method constants.

data StdMethod Source #

HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).

Constructors

GET 
POST 
HEAD 
PUT 
DELETE 
TRACE 
CONNECT 
OPTIONS 
PATCH 

Instances

Bounded StdMethod Source # 
Enum StdMethod Source # 
Eq StdMethod Source # 
Ord StdMethod Source # 
Read StdMethod Source # 
Show StdMethod Source # 
Ix StdMethod Source # 

parseMethod :: Method -> Either ByteString StdMethod Source #

Convert a method ByteString to a StdMethod if possible.

renderMethod :: Either ByteString StdMethod -> Method Source #

Convert an algebraic method to a ByteString.

renderStdMethod :: StdMethod -> Method Source #

Convert a StdMethod to a ByteString.

Versions

data HttpVersion Source #

HTTP Version.

Note that the Show instance is intended merely for debugging.

Constructors

HttpVersion 

Fields

Instances

http09 :: HttpVersion Source #

HTTP 0.9

http10 :: HttpVersion Source #

HTTP 1.0

http11 :: HttpVersion Source #

HTTP 1.1

http20 :: HttpVersion Source #

HTTP 2.0

Status

data Status Source #

HTTP Status.

Only the statusCode is used for comparisons.

Please use mkStatus to create status codes from code and message, or the Enum instance or the status code constants (like ok200). There might be additional record members in the future.

Note that the Show instance is only for debugging.

Constructors

Status 

Fields

Instances

mkStatus :: Int -> ByteString -> Status Source #

Create a Status from status code and message.

status100 :: Status Source #

Continue 100

continue100 :: Status Source #

Continue 100

status101 :: Status Source #

Switching Protocols 101

switchingProtocols101 :: Status Source #

Switching Protocols 101

status200 :: Status Source #

OK 200

ok200 :: Status Source #

OK 200

status201 :: Status Source #

Created 201

created201 :: Status Source #

Created 201

status202 :: Status Source #

Accepted 202

accepted202 :: Status Source #

Accepted 202

status203 :: Status Source #

Non-Authoritative Information 203

nonAuthoritative203 :: Status Source #

Non-Authoritative Information 203

status204 :: Status Source #

No Content 204

noContent204 :: Status Source #

No Content 204

status205 :: Status Source #

Reset Content 205

resetContent205 :: Status Source #

Reset Content 205

status206 :: Status Source #

Partial Content 206

partialContent206 :: Status Source #

Partial Content 206

status300 :: Status Source #

Multiple Choices 300

multipleChoices300 :: Status Source #

Multiple Choices 300

status301 :: Status Source #

Moved Permanently 301

movedPermanently301 :: Status Source #

Moved Permanently 301

status302 :: Status Source #

Found 302

found302 :: Status Source #

Found 302

status303 :: Status Source #

See Other 303

seeOther303 :: Status Source #

See Other 303

status304 :: Status Source #

Not Modified 304

notModified304 :: Status Source #

Not Modified 304

status305 :: Status Source #

Use Proxy 305

useProxy305 :: Status Source #

Use Proxy 305

status307 :: Status Source #

Temporary Redirect 307

temporaryRedirect307 :: Status Source #

Temporary Redirect 307

status308 :: Status Source #

Permanent Redirect 308

permanentRedirect308 :: Status Source #

Permanent Redirect 308

status400 :: Status Source #

Bad Request 400

badRequest400 :: Status Source #

Bad Request 400

status401 :: Status Source #

Unauthorized 401

unauthorized401 :: Status Source #

Unauthorized 401

status402 :: Status Source #

Payment Required 402

paymentRequired402 :: Status Source #

Payment Required 402

status403 :: Status Source #

Forbidden 403

forbidden403 :: Status Source #

Forbidden 403

status404 :: Status Source #

Not Found 404

notFound404 :: Status Source #

Not Found 404

status405 :: Status Source #

Method Not Allowed 405

methodNotAllowed405 :: Status Source #

Method Not Allowed 405

status406 :: Status Source #

Not Acceptable 406

notAcceptable406 :: Status Source #

Not Acceptable 406

status407 :: Status Source #

Proxy Authentication Required 407

proxyAuthenticationRequired407 :: Status Source #

Proxy Authentication Required 407

status408 :: Status Source #

Request Timeout 408

requestTimeout408 :: Status Source #

Request Timeout 408

status409 :: Status Source #

Conflict 409

conflict409 :: Status Source #

Conflict 409

status410 :: Status Source #

Gone 410

gone410 :: Status Source #

Gone 410

status411 :: Status Source #

Length Required 411

lengthRequired411 :: Status Source #

Length Required 411

status412 :: Status Source #

Precondition Failed 412

preconditionFailed412 :: Status Source #

Precondition Failed 412

status413 :: Status Source #

Request Entity Too Large 413

requestEntityTooLarge413 :: Status Source #

Request Entity Too Large 413

status414 :: Status Source #

Request-URI Too Long 414

requestURITooLong414 :: Status Source #

Request-URI Too Long 414

status415 :: Status Source #

Unsupported Media Type 415

unsupportedMediaType415 :: Status Source #

Unsupported Media Type 415

status416 :: Status Source #

Requested Range Not Satisfiable 416

requestedRangeNotSatisfiable416 :: Status Source #

Requested Range Not Satisfiable 416

status417 :: Status Source #

Expectation Failed 417

expectationFailed417 :: Status Source #

Expectation Failed 417

status418 :: Status Source #

I'm a teapot 418

imATeapot418 :: Status Source #

I'm a teapot 418

status422 :: Status Source #

Unprocessable Entity 422 (RFC 4918)

unprocessableEntity422 :: Status Source #

Unprocessable Entity 422 (RFC 4918)

status428 :: Status Source #

Precondition Required 428 (RFC 6585)

preconditionRequired428 :: Status Source #

Precondition Required 428 (RFC 6585)

status429 :: Status Source #

Too Many Requests 429 (RFC 6585)

tooManyRequests429 :: Status Source #

Too Many Requests 429 (RFC 6585)

status431 :: Status Source #

Request Header Fields Too Large 431 (RFC 6585)

requestHeaderFieldsTooLarge431 :: Status Source #

Request Header Fields Too Large 431 (RFC 6585)

status500 :: Status Source #

Internal Server Error 500

internalServerError500 :: Status Source #

Internal Server Error 500

status501 :: Status Source #

Not Implemented 501

notImplemented501 :: Status Source #

Not Implemented 501

status502 :: Status Source #

Bad Gateway 502

badGateway502 :: Status Source #

Bad Gateway 502

status503 :: Status Source #

Service Unavailable 503

serviceUnavailable503 :: Status Source #

Service Unavailable 503

status504 :: Status Source #

Gateway Timeout 504

gatewayTimeout504 :: Status Source #

Gateway Timeout 504

status505 :: Status Source #

HTTP Version Not Supported 505

httpVersionNotSupported505 :: Status Source #

HTTP Version Not Supported 505

status511 :: Status Source #

Network Authentication Required 511 (RFC 6585)

networkAuthenticationRequired511 :: Status Source #

Network Authentication Required 511 (RFC 6585)

statusIsInformational :: Status -> Bool Source #

Informational class

statusIsSuccessful :: Status -> Bool Source #

Successful class

statusIsRedirection :: Status -> Bool Source #

Redirection class

statusIsClientError :: Status -> Bool Source #

Client Error class

statusIsServerError :: Status -> Bool Source #

Server Error class

Headers

Types

type Header = (HeaderName, ByteString) Source #

Header

type HeaderName = CI ByteString Source #

Header name

type RequestHeaders = [Header] Source #

Request Headers

type ResponseHeaders = [Header] Source #

Response Headers

Common headers

hAccept :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hAcceptLanguage :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hAuthorization :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hCacheControl :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hCookie :: HeaderName Source #

HTTP Header names according to https://tools.ietf.org/html/rfc6265#section-4

hConnection :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hContentEncoding :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hContentLength :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hContentMD5 :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hContentType :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hDate :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hIfModifiedSince :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hIfRange :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hLastModified :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hLocation :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hRange :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hReferer :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hServer :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

hUserAgent :: HeaderName Source #

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

Byte ranges

data ByteRange Source #

RFC 2616 Byte range (individual).

Negative indices are not allowed!

Constructors

ByteRangeFrom !Integer 
ByteRangeFromTo !Integer !Integer 
ByteRangeSuffix !Integer 

Instances

Eq ByteRange Source # 
Data ByteRange Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteRange -> c ByteRange #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteRange #

toConstr :: ByteRange -> Constr #

dataTypeOf :: ByteRange -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ByteRange) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteRange) #

gmapT :: (forall b. Data b => b -> b) -> ByteRange -> ByteRange #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteRange -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteRange -> r #

gmapQ :: (forall d. Data d => d -> u) -> ByteRange -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteRange -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteRange -> m ByteRange #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteRange -> m ByteRange #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteRange -> m ByteRange #

Ord ByteRange Source # 
Show ByteRange Source # 

renderByteRangeBuilder :: ByteRange -> Builder Source #

renderByteRange :: ByteRange -> ByteString Source #

type ByteRanges = [ByteRange] Source #

RFC 2616 Byte ranges (set).

renderByteRangesBuilder :: ByteRanges -> Builder Source #

renderByteRanges :: ByteRanges -> ByteString Source #

parseByteRanges :: ByteString -> Maybe ByteRanges Source #

Parse the value of a Range header into a ByteRanges.

>>> parseByteRanges "error"
Nothing
>>> parseByteRanges "bytes=0-499"
Just [ByteRangeFromTo 0 499]
>>> parseByteRanges "bytes=500-999"
Just [ByteRangeFromTo 500 999]
>>> parseByteRanges "bytes=-500"
Just [ByteRangeSuffix 500]
>>> parseByteRanges "bytes=9500-"
Just [ByteRangeFrom 9500]
>>> parseByteRanges "bytes=0-0,-1"
Just [ByteRangeFromTo 0 0,ByteRangeSuffix 1]
>>> parseByteRanges "bytes=500-600,601-999"
Just [ByteRangeFromTo 500 600,ByteRangeFromTo 601 999]
>>> parseByteRanges "bytes=500-700,601-999"
Just [ByteRangeFromTo 500 700,ByteRangeFromTo 601 999]

URI

Query string

type QueryItem = (ByteString, Maybe ByteString) Source #

Query item

type Query = [QueryItem] Source #

Query.

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

type SimpleQueryItem = (ByteString, ByteString) Source #

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

type SimpleQuery = [SimpleQueryItem] Source #

Simplified Query type without support for parameter-less items.

simpleQueryToQuery :: SimpleQuery -> Query Source #

Convert SimpleQuery to Query.

renderQuery Source #

Arguments

:: Bool

prepend question mark?

-> Query 
-> ByteString 

Convert Query to ByteString.

renderQueryBuilder Source #

Arguments

:: Bool

prepend a question mark?

-> Query 
-> Builder 

Convert Query to a Builder.

renderSimpleQuery Source #

Arguments

:: Bool

prepend question mark?

-> SimpleQuery 
-> ByteString 

Convert SimpleQuery to ByteString.

parseQuery :: ByteString -> Query Source #

Split out the query string into a list of keys and values. A few importants points:

  • The result returned is still bytestrings, since we perform no character decoding here. Most likely, you will want to use UTF-8 decoding, but this is left to the user of the library.
  • Percent decoding errors are ignored. In particular, "%Q" will be output as "%Q".

parseSimpleQuery :: ByteString -> SimpleQuery Source #

Parse SimpleQuery from a ByteString.

Escape only parts

renderQueryPartialEscape Source #

Arguments

:: Bool

prepend question mark?

-> PartialEscapeQuery 
-> ByteString 

Convert PartialEscapeQuery to ByteString.

renderQueryBuilderPartialEscape Source #

Arguments

:: Bool

prepend a question mark?

-> PartialEscapeQuery 
-> Builder 

Convert PartialEscapeQuery to a Builder.

data EscapeItem Source #

For some URIs characters must not be URI encoded, eg + or : in q=a+language:haskell+created:2009-01-01..2009-02-01&sort=stars The character list unreservedPI instead of unreservedQS would solve this. But we explicitly decide what part to encode. This is mandatory when searching for +: q=%2B+language:haskell.

Constructors

QE ByteString 
QN ByteString 

Instances

type PartialEscapeQueryItem = (ByteString, [EscapeItem]) Source #

Query item

type PartialEscapeQuery = [PartialEscapeQueryItem] Source #

Query with some chars that should not be escaped.

General form: a=b&c=d:e+f&g=h

Text query string (UTF8 encoded)

type QueryText = [(Text, Maybe Text)] Source #

Like Query, but with Text instead of ByteString (UTF8-encoded).

queryTextToQuery :: QueryText -> Query Source #

Convert QueryText to Query.

queryToQueryText :: Query -> QueryText Source #

Convert Query to QueryText (leniently decoding the UTF-8).

renderQueryText Source #

Arguments

:: Bool

prepend a question mark?

-> QueryText 
-> Builder 

Convert QueryText to a Builder.

parseQueryText :: ByteString -> QueryText Source #

Parse QueryText from a ByteString. See parseQuery for details.

Generalized query types

class QueryLike a where Source #

Types which can, and commonly are, converted to Query are in this class.

You can use lists of simple key value pairs, with ByteString (strict, or lazy: ByteString), Text, or String as the key/value types. You can also have the value type lifted into a Maybe to support keys without values; and finally it is possible to put each pair into a Maybe for key-value pairs that aren't always present.

Minimal complete definition

toQuery

Methods

toQuery :: a -> Query Source #

Convert to Query.

Instances

(QueryKeyLike k, QueryValueLike v) => QueryLike [Maybe (k, v)] Source # 

Methods

toQuery :: [Maybe (k, v)] -> Query Source #

(QueryKeyLike k, QueryValueLike v) => QueryLike [(k, v)] Source # 

Methods

toQuery :: [(k, v)] -> Query Source #

Path segments

encodePathSegments :: [Text] -> Builder Source #

Encodes a list of path segments into a valid URL fragment.

This function takes the following three steps:

  • UTF-8 encodes the characters.
  • Performs percent encoding on all unreserved characters, as well as :@=+$,
  • Prepends each segment with a slash.

For example:

encodePathSegments [\"foo\", \"bar\", \"baz\"]

"/foo/bar/baz"

encodePathSegments [\"foo bar\", \"baz\/bin\"]

"/foo%20bar/baz%2Fbin"

encodePathSegments [\"שלום\"]

"/%D7%A9%D7%9C%D7%95%D7%9D"

Huge thanks to Jeremy Shaw who created the original implementation of this function in web-routes and did such thorough research to determine all correct escaping procedures.

decodePathSegments :: ByteString -> [Text] Source #

Parse a list of path segments from a valid URL fragment.

encodePathSegmentsRelative :: [Text] -> Builder Source #

Like encodePathSegments, but without the initial slash.

Path (segments + query string)

extractPath :: ByteString -> ByteString Source #

Extract whole path (path segments + query) from a RFC 2616 Request-URI.

>>> extractPath "/path"
"/path"

>>> extractPath "http://example.com:8080/path"
"/path"

>>> extractPath "http://example.com"
"/"

>>> extractPath ""
"/"

encodePath :: [Text] -> Query -> Builder Source #

Encode a whole path (path segments + query).

decodePath :: ByteString -> ([Text], Query) Source #

Decode a whole path (path segments + query).

URL encoding / decoding

urlEncodeBuilder Source #

Arguments

:: Bool

Whether input is in query string. True: Query string, False: Path element

-> ByteString 
-> Builder 

Percent-encoding for URLs (using Builder).

urlEncode Source #

Arguments

:: Bool

Whether to decode + to ' '

-> ByteString

The ByteString to encode as URL

-> ByteString

The encoded URL

Percent-encoding for URLs.

urlDecode Source #

Arguments

:: Bool

Whether to decode + to ' '

-> ByteString 
-> ByteString 

Percent-decoding.