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

Safe HaskellSafe-Infered

Network.HTTP.Types

Contents

Synopsis

General

Methods

type Method = AsciiSource

HTTP method (flat string type).

data StdMethod Source

HTTP standard method (as defined by RFC 2616).

Constructors

GET 
POST 
HEAD 
PUT 
DELETE 
TRACE 
CONNECT 
OPTIONS 

parseMethod :: Method -> Either Ascii StdMethodSource

Convert a method ByteString to a StdMethod if possible.

renderMethod :: Either Ascii StdMethod -> MethodSource

Convert an algebraic method to a ByteString.

renderStdMethod :: StdMethod -> MethodSource

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

httpMajor :: !Int
 
httpMinor :: !Int
 

Status

data Status Source

HTTP Status.

Only the statusCode is used for comparisons.

Note that the Show instance is only for debugging.

Constructors

Status 

Instances

status100 :: StatusSource

Continue 100

continue100 :: StatusSource

Continue 100

status101 :: StatusSource

Switching Protocols 101

switchingProtocols101 :: StatusSource

Switching Protocols 101

status201 :: StatusSource

Created 201

created201 :: StatusSource

Created 201

status202 :: StatusSource

Accepted 202

accepted202 :: StatusSource

Accepted 202

status203 :: StatusSource

Non-Authoritative Information 203

nonAuthoritative203 :: StatusSource

Non-Authoritative Information 203

status204 :: StatusSource

No Content 204

noContent204 :: StatusSource

No Content 204

status205 :: StatusSource

Reset Content 205

resetContent205 :: StatusSource

Reset Content 205

status206 :: StatusSource

Partial Content 206

partialContent206 :: StatusSource

Partial Content 206

status300 :: StatusSource

Multiple Choices 300

multipleChoices300 :: StatusSource

Multiple Choices 300

status301 :: StatusSource

Moved Permanently 301

movedPermanently301 :: StatusSource

Moved Permanently 301

status302 :: StatusSource

Found 302

found302 :: StatusSource

Found 302

status303 :: StatusSource

See Other 303

seeOther303 :: StatusSource

See Other 303

status304 :: StatusSource

Not Modified 304

notModified304 :: StatusSource

Not Modified 304

status305 :: StatusSource

Use Proxy 305

useProxy305 :: StatusSource

Use Proxy 305

status307 :: StatusSource

Temporary Redirect 307

temporaryRedirect307 :: StatusSource

Temporary Redirect 307

status400 :: StatusSource

Bad Request 400

badRequest400 :: StatusSource

Bad Request 400

status401 :: StatusSource

Unauthorized 401

unauthorized401 :: StatusSource

Unauthorized 401

status402 :: StatusSource

Payment Required 402

paymentRequired402 :: StatusSource

Payment Required 402

status403 :: StatusSource

Forbidden 403

forbidden403 :: StatusSource

Forbidden 403

status404 :: StatusSource

Not Found 404

notFound404 :: StatusSource

Not Found 404

status405 :: StatusSource

Method Not Allowed 405

methodNotAllowed405 :: StatusSource

Method Not Allowed 405

status406 :: StatusSource

Not Acceptable 406

notAcceptable406 :: StatusSource

Not Acceptable 406

status407 :: StatusSource

Proxy Authentication Required 407

proxyAuthenticationRequired407 :: StatusSource

Proxy Authentication Required 407

status408 :: StatusSource

Request Timeout 408

requestTimeout408 :: StatusSource

Request Timeout 408

status409 :: StatusSource

Conflict 409

conflict409 :: StatusSource

Conflict 409

gone410 :: StatusSource

Gone 410

status411 :: StatusSource

Length Required 411

lengthRequired411 :: StatusSource

Length Required 411

status412 :: StatusSource

Precondition Failed 412

preconditionFailed412 :: StatusSource

Precondition Failed 412

status413 :: StatusSource

Request Entity Too Large 413

requestEntityTooLarge413 :: StatusSource

Request Entity Too Large 413

status414 :: StatusSource

Request-URI Too Long 414

requestURITooLong414 :: StatusSource

Request-URI Too Long 414

status415 :: StatusSource

Unsupported Media Type 415

unsupportedMediaType415 :: StatusSource

Unsupported Media Type 415

status416 :: StatusSource

Requested Range Not Satisfiable 416

requestedRangeNotSatisfiable416 :: StatusSource

Requested Range Not Satisfiable 416

status417 :: StatusSource

Expectation Failed 417

expectationFailed417 :: StatusSource

Expectation Failed 417

status418 :: StatusSource

I'm a teapot 418

imATeaPot418 :: StatusSource

I'm a teapot 418

status500 :: StatusSource

Internal Server Error 500

internalServerError500 :: StatusSource

Internal Server Error 500

status501 :: StatusSource

Not Implemented 501

notImplemented501 :: StatusSource

Not Implemented 501

status502 :: StatusSource

Bad Gateway 502

badGateway502 :: StatusSource

Bad Gateway 502

status503 :: StatusSource

Service Unavailable 503

serviceUnavailable503 :: StatusSource

Service Unavailable 503

status504 :: StatusSource

Gateway Timeout 504

gatewayTimeout504 :: StatusSource

Gateway Timeout 504

status505 :: StatusSource

HTTP Version Not Supported 505

httpVersionNotSupported505 :: StatusSource

HTTP Version Not Supported 505

Headers

type Header = (CI Ascii, Ascii)Source

Header

type RequestHeaders = [Header]Source

Request Headers

type ResponseHeaders = [Header]Source

Response Headers

Query string

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.

renderQuerySource

Arguments

:: Bool

prepend question mark?

-> Query 
-> Ascii 

Convert Query to ByteString.

renderQueryBuilderSource

Arguments

:: Bool

prepend a question mark?

-> Query 
-> Builder 

renderSimpleQuerySource

Arguments

:: Bool

prepend question mark?

-> SimpleQuery 
-> Ascii 

Convert SimpleQuery to ByteString.

parseQuery :: ByteString -> QuerySource

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.

Text query string (UTF8 encoded)

renderQueryTextSource

Arguments

:: Bool

prepend a question mark?

-> QueryText 
-> Builder 

Path segments

encodePathSegments :: [Text] -> BuilderSource

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 :@=+$,
  • Intercalates with a slash.

For example:

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

"foo/bar/baz"

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

"foo%20bar/baz%2Fbin"

 encodePathInfo [\"שלום\"]

"%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.

Path (segments + query string)

URL encoding / decoding

urlEncodeBuilderSource

Arguments

:: Bool

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

-> ByteString 
-> Builder 

urlDecodeSource

Arguments

:: Bool

Whether to decode + to ' '

-> ByteString 
-> ByteString 

Percent-decoding.

Deprecated functions

statusNotAllowed :: StatusSource

Method Not Allowed 405 (DEPRECATED!)

statusContinue :: StatusSource

Continue 100 (DEPRECATED)

statusSwitchingProtocols :: StatusSource

Switching Protocols 101 (DEPRECATED)

statusOK :: StatusSource

OK 200 (DEPRECATED)

statusCreated :: StatusSource

Created 201 (DEPRECATED)

statusAccepted :: StatusSource

Accepted 202 (DEPRECATED)

statusNonAuthoritative :: StatusSource

Non-Authoritative Information 203 (DEPRECATED)

statusNoContent :: StatusSource

No Content 204 (DEPRECATED)

statusResetContent :: StatusSource

Reset Content 205 (DEPRECATED)

statusPartialContent :: StatusSource

Partial Content 206 (DEPRECATED)

statusMultipleChoices :: StatusSource

Multiple Choices 300 (DEPRECATED)

statusMovedPermanently :: StatusSource

Moved Permanently 301 (DEPRECATED)

statusFound :: StatusSource

Found 302 (DEPRECATED)

statusSeeOther :: StatusSource

See Other 303 (DEPRECATED)

statusNotModified :: StatusSource

Not Modified 304 (DEPRECATED)

statusUseProxy :: StatusSource

Use Proxy 305 (DEPRECATED)

statusTemporaryRedirect :: StatusSource

Temporary Redirect 307 (DEPRECATED)

statusBadRequest :: StatusSource

Bad Request 400 (DEPRECATED)

statusUnauthorized :: StatusSource

Unauthorized 401 (DEPRECATED)

statusPaymentRequired :: StatusSource

Payment Required 402 (DEPRECATED)

statusForbidden :: StatusSource

Forbidden 403 (DEPRECATED)

statusNotFound :: StatusSource

Not Found 404 (DEPRECATED)

statusNotAcceptable :: StatusSource

Not Acceptable 406 (DEPRECATED)

statusProxyAuthenticationRequired :: StatusSource

Proxy Authentication Required 407

statusRequestTimeout :: StatusSource

Request Timeout 408 (DEPRECATED)

statusConflict :: StatusSource

Conflict 409 (DEPRECATED)

statusGone :: StatusSource

Gone 410 (DEPRECATED)

statusLengthRequired :: StatusSource

Length Required 411 (DEPRECATED)

statusPreconditionFailed :: StatusSource

Precondition Failed 412 (DEPRECATED)

statusRequestEntityTooLarge :: StatusSource

Request Entity Too Large 413 (DEPRECATED)

statusRequestURITooLong :: StatusSource

Request-URI Too Long 414 (DEPRECATED)

statusUnsupportedMediaType :: StatusSource

Unsupported Media Type 415 (DEPRECATED)

statusRequestedRangeNotSatisfiable :: StatusSource

Requested Range Not Satisfiable 416 (DEPRECATED)

statusExpectationFailed :: StatusSource

Expectation Failed 417 (DEPRECATED)

statusImATeapot :: StatusSource

I'm a teapot 418 (DEPRECATED)

statusServerError :: StatusSource

Internal Server Error 500 (DEPRECATED)

statusNotImplemented :: StatusSource

Not Implemented 501 (DEPRECATED)

statusBadGateway :: StatusSource

Bad Gateway 502 (DEPRECATED)

statusServiceUnavailable :: StatusSource

Service Unavailable 503 (DEPRECATED)

statusGatewayTimeout :: StatusSource

Gateway Timeout 504 (DEPRECATED)

statusHTTPVersionNotSupported :: StatusSource

HTTP Version Not Supported 505 (DEPRECATED)