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

Network.HTTP.Types

Contents

Synopsis

General

type Ascii = ByteStringSource

Methods

type Method = AsciiSource

HTTP method (flat string type).

methodGet :: MethodSource

methodPost :: MethodSource

HTTP Method constants.

methodHead :: MethodSource

methodPut :: MethodSource

methodDelete :: MethodSource

methodTrace :: MethodSource

methodConnect :: MethodSource

methodOptions :: MethodSource

data StdMethod Source

HTTP standard method (as defined by RFC 2616).

Constructors

GET 
POST 
HEAD 
PUT 
DELETE 
TRACE 
CONNECT 
OPTIONS 

Instances

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
 

Instances

http09 :: HttpVersionSource

HTTP 0.9

http10 :: HttpVersionSource

HTTP 1.0

http11 :: HttpVersionSource

HTTP 1.1

Status

data Status Source

HTTP Status.

Only the statusCode is used for comparisons.

Note that the Show instance is only for debugging.

Constructors

Status 

Fields

statusCode :: Int
 
statusMessage :: Ascii
 

Instances

status200 :: StatusSource

statusOK :: StatusSource

OK

status201 :: StatusSource

statusCreated :: StatusSource

Created

status206 :: StatusSource

statusPartialContent :: StatusSource

PartialContent

status301 :: StatusSource

statusMovedPermanently :: StatusSource

Moved Permanently

status302 :: StatusSource

statusFound :: StatusSource

Found

status303 :: StatusSource

statusSeeOther :: StatusSource

See Other

status304 :: StatusSource

statusNotModified :: StatusSource

Not Modified

status400 :: StatusSource

statusBadRequest :: StatusSource

Bad Request

status401 :: StatusSource

statusUnauthorized :: StatusSource

Unauthorized

status403 :: StatusSource

statusForbidden :: StatusSource

Forbidden

status404 :: StatusSource

statusNotFound :: StatusSource

Not Found

status405 :: StatusSource

statusNotAllowed :: StatusSource

Method Not Allowed

status412 :: StatusSource

statusPreconditionFailed :: StatusSource

Precondition Failed

status416 :: StatusSource

statusRequestedRangeNotSatisfiable :: StatusSource

Requested Range Not Satisfiable

status500 :: StatusSource

statusServerError :: StatusSource

Internal Server Error

status501 :: StatusSource

statusNotImplemented :: StatusSource

Not Implemented

Headers

type Header = (CI Ascii, Ascii)Source

Header

type RequestHeaders = [Header]Source

Request Headers

type ResponseHeaders = [Header]Source

Response Headers

headerAccept :: Ascii -> HeaderSource

headerAuthorization :: Ascii -> HeaderSource

HTTP Headers

headerCacheControl :: Ascii -> HeaderSource

headerConnection :: Ascii -> HeaderSource

headerContentLength :: Ascii -> HeaderSource

headerContentType :: Ascii -> HeaderSource

headerContentMD5 :: Ascii -> HeaderSource

headerDate :: Ascii -> HeaderSource

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 -> QuerySource

Convert SimpleQuery to Query.

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.

parseSimpleQuery :: ByteString -> SimpleQuerySource

Parse SimpleQuery from a ByteString.

Text query string (UTF8 encoded)

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

queryTextToQuery :: QueryText -> QuerySource

queryToQueryText :: Query -> QueryTextSource

renderQueryTextSource

Arguments

:: Bool

prepend a question mark?

-> QueryText 
-> Builder 

parseQueryText :: ByteString -> QueryTextSource

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.

decodePathSegments :: ByteString -> [Text]Source

Path (segments + query string)

encodePath :: [Text] -> Query -> BuilderSource

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

URL encoding / decoding

urlEncodeBuilderSource

Arguments

:: Bool

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

-> ByteString 
-> Builder 

urlEncode :: Bool -> ByteString -> AsciiSource

urlDecodeSource

Arguments

:: Bool

Whether to decode + to ' '

-> ByteString 
-> ByteString 

Percent-decoding.