Network.HTTP.Types
Contents
- type Ascii = ByteString
- type Method = Ascii
- methodGet :: Method
- methodPost :: Method
- methodHead :: Method
- methodPut :: Method
- methodDelete :: Method
- methodTrace :: Method
- methodConnect :: Method
- methodOptions :: Method
- data StdMethod
- parseMethod :: Method -> Either Ascii StdMethod
- renderMethod :: Either Ascii StdMethod -> Method
- renderStdMethod :: StdMethod -> Method
- data HttpVersion = HttpVersion {}
- http09 :: HttpVersion
- http10 :: HttpVersion
- http11 :: HttpVersion
- data Status = Status {
- statusCode :: Int
- statusMessage :: Ascii
- status100 :: Status
- statusContinue :: Status
- status101 :: Status
- statusSwitchingProtocols :: Status
- status200 :: Status
- statusOK :: Status
- status201 :: Status
- statusCreated :: Status
- status202 :: Status
- statusAccepted :: Status
- status203 :: Status
- statusNonAuthoritative :: Status
- status204 :: Status
- statusNoContent :: Status
- status205 :: Status
- statusResetContent :: Status
- status206 :: Status
- statusPartialContent :: Status
- status300 :: Status
- statusMultipleChoices :: Status
- status301 :: Status
- statusMovedPermanently :: Status
- status302 :: Status
- statusFound :: Status
- status303 :: Status
- statusSeeOther :: Status
- status304 :: Status
- statusNotModified :: Status
- status305 :: Status
- statusUseProxy :: Status
- status307 :: Status
- statusTemporaryRedirect :: Status
- status400 :: Status
- statusBadRequest :: Status
- status401 :: Status
- statusUnauthorized :: Status
- status402 :: Status
- statusPaymentRequired :: Status
- status403 :: Status
- statusForbidden :: Status
- status404 :: Status
- statusNotFound :: Status
- status405 :: Status
- statusNotAllowed :: Status
- status406 :: Status
- statusNotAcceptable :: Status
- status407 :: Status
- statusProxyAuthenticationRequired :: Status
- status408 :: Status
- statusRequestTimeout :: Status
- status409 :: Status
- statusConflict :: Status
- status410 :: Status
- statusGone :: Status
- status411 :: Status
- statusLengthRequired :: Status
- status412 :: Status
- statusPreconditionFailed :: Status
- status413 :: Status
- statusRequestEntityTooLarge :: Status
- status414 :: Status
- statusRequestURITooLong :: Status
- status415 :: Status
- statusUnsupportedMediaType :: Status
- status416 :: Status
- statusRequestedRangeNotSatisfiable :: Status
- status417 :: Status
- statusExpectationFailed :: Status
- status418 :: Status
- statusImATeapot :: Status
- status500 :: Status
- statusServerError :: Status
- status501 :: Status
- statusNotImplemented :: Status
- status502 :: Status
- statusBadGateway :: Status
- status503 :: Status
- statusServiceUnavailable :: Status
- status504 :: Status
- statusGatewayTimeout :: Status
- status505 :: Status
- statusHTTPVersionNotSupported :: Status
- type Header = (CI Ascii, Ascii)
- type RequestHeaders = [Header]
- type ResponseHeaders = [Header]
- headerAccept :: Ascii -> Header
- headerAuthorization :: Ascii -> Header
- headerCacheControl :: Ascii -> Header
- headerConnection :: Ascii -> Header
- headerContentLength :: Ascii -> Header
- headerContentType :: Ascii -> Header
- headerContentMD5 :: Ascii -> Header
- headerDate :: Ascii -> Header
- type QueryItem = (ByteString, Maybe ByteString)
- type Query = [QueryItem]
- type SimpleQueryItem = (ByteString, ByteString)
- type SimpleQuery = [SimpleQueryItem]
- simpleQueryToQuery :: SimpleQuery -> Query
- renderQuery :: Bool -> Query -> Ascii
- renderQueryBuilder :: Bool -> Query -> Builder
- renderSimpleQuery :: Bool -> SimpleQuery -> Ascii
- parseQuery :: ByteString -> Query
- parseSimpleQuery :: ByteString -> SimpleQuery
- type QueryText = [(Text, Maybe Text)]
- queryTextToQuery :: QueryText -> Query
- queryToQueryText :: Query -> QueryText
- renderQueryText :: Bool -> QueryText -> Builder
- parseQueryText :: ByteString -> QueryText
- encodePathSegments :: [Text] -> Builder
- decodePathSegments :: ByteString -> [Text]
- encodePath :: [Text] -> Query -> Builder
- decodePath :: ByteString -> ([Text], Query)
- urlEncodeBuilder :: Bool -> ByteString -> Builder
- urlEncode :: Bool -> ByteString -> Ascii
- urlDecode :: Bool -> ByteString -> ByteString
General
type Ascii = ByteString
Methods
methodPost :: Method
HTTP Method constants.
methodHead :: Method
data StdMethod
HTTP standard method (as defined by RFC 2616).
parseMethod :: Method -> Either Ascii StdMethod
Convert a method ByteString
to a StdMethod
if possible.
renderMethod :: Either Ascii 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 | |
Instances
HTTP 0.9
HTTP 1.0
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
|
Continue
statusSwitchingProtocols :: Status
Switching Protocols
Created
Accepted
statusNonAuthoritative :: Status
Non-Authoritative Information
No Content
Reset Content
statusPartialContent :: Status
PartialContent
statusMultipleChoices :: Status
Multiple Choices
statusMovedPermanently :: Status
Moved Permanently
Found
See Other
Not Modified
Use Proxy
statusTemporaryRedirect :: Status
Temporary Redirect
Bad Request
Unauthorized
statusPaymentRequired :: Status
Payment Required
Forbidden
Not Found
Method Not Allowed
Not Acceptable
statusProxyAuthenticationRequired :: Status
Proxy Authentication Required
statusRequestTimeout :: Status
Request Timeout
Conflict
statusGone :: Status
Gone
statusLengthRequired :: Status
Length Required
statusPreconditionFailed :: Status
Precondition Failed
statusRequestEntityTooLarge :: Status
Request Entity Too Large
statusRequestURITooLong :: Status
Request-URI Too Long
statusUnsupportedMediaType :: Status
Unsupported Media Type
statusRequestedRangeNotSatisfiable :: Status
Requested Range Not Satisfiable
statusExpectationFailed :: Status
Expectation Failed
I'm a teapot
Internal Server Error
statusNotImplemented :: Status
Not Implemented
Bad Gateway
statusServiceUnavailable :: Status
Service Unavailable
statusGatewayTimeout :: Status
Gateway Timeout
statusHTTPVersionNotSupported :: Status
HTTP Version Not Supported
Headers
type RequestHeaders = [Header]
Request Headers
type ResponseHeaders = [Header]
Response Headers
headerAccept :: Ascii -> Header
headerAuthorization :: Ascii -> Header
HTTP Headers
headerCacheControl :: Ascii -> Header
headerConnection :: Ascii -> Header
headerContentLength :: Ascii -> Header
headerContentType :: Ascii -> Header
headerContentMD5 :: Ascii -> Header
headerDate :: Ascii -> Header
Query string
type QueryItem = (ByteString, Maybe ByteString)
Query item
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.
simpleQueryToQuery :: SimpleQuery -> Query
Convert SimpleQuery
to Query
.
Arguments
:: Bool | prepend question mark? |
-> SimpleQuery | |
-> Ascii |
Convert SimpleQuery
to ByteString
.
parseQuery :: ByteString -> Query
Split out the query string into a list of keys and values. A few importants points:
parseSimpleQuery :: ByteString -> SimpleQuery
Parse SimpleQuery
from a ByteString
.
Text query string (UTF8 encoded)
queryTextToQuery :: QueryText -> Query
queryToQueryText :: Query -> QueryText
Path segments
encodePathSegments :: [Text] -> Builder
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]
Path (segments + query string)
encodePath :: [Text] -> Query -> Builder
decodePath :: ByteString -> ([Text], Query)
URL encoding / decoding
Arguments
:: Bool | Whether input is in query string. True: Query string, False: Path element |
-> ByteString | |
-> Builder |
urlEncode :: Bool -> ByteString -> Ascii