HTTP method (flat ByteString type).

HTTP GET Method

HTTP POST Method

HTTP HEAD Method

HTTP PUT Method

HTTP DELETE Method

HTTP TRACE Method

HTTP CONNECT Method

HTTP OPTIONS Method

HTTP PATCH Method

Since: 0.8.0

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

Since: 0.2.0

Convert a method ByteString to a StdMethod if possible.

Since: 0.2.0

Convert an algebraic method to a ByteString.

renderMethod (parseMethod bs) == bs

Since: 0.3.0

Convert a StdMethod to a ByteString.

Since: 0.2.0

HTTP Version.

Note that the Show instance is intended merely for debugging.

HTTP 0.9

HTTP 1.0

HTTP 1.1

HTTP 2.0

Since: 0.10

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.

Create a Status from a status code and message.

Continue 100

Since: 0.6.6

Continue 100

Since: 0.6.6

Switching Protocols 101

Since: 0.6.6

Switching Protocols 101

Since: 0.6.6

OK 200

OK 200

Created 201

Created 201

Accepted 202

Since: 0.6.6

Accepted 202

Since: 0.6.6

Non-Authoritative Information 203

Since: 0.6.6

Non-Authoritative Information 203

Since: 0.6.6

No Content 204

Since: 0.6.6

No Content 204

Since: 0.6.6

Reset Content 205

Since: 0.6.6

Reset Content 205

Since: 0.6.6

Partial Content 206

Since: 0.5.1

Partial Content 206

Since: 0.5.1

Multiple Choices 300

Multiple Choices 300

Moved Permanently 301

Moved Permanently 301

Found 302

Found 302

See Other 303

See Other 303

Not Modified 304

Since: 0.6.1

Not Modified 304

Since: 0.6.1

Use Proxy 305

Since: 0.6.6

Use Proxy 305

Since: 0.6.6

Temporary Redirect 307

Since: 0.6.6

Temporary Redirect 307

Since: 0.6.6

Permanent Redirect 308

Since: 0.9

Permanent Redirect 308

Since: 0.9

Bad Request 400

Bad Request 400

Unauthorized 401

Unauthorized 401

Payment Required 402

Since: 0.6.6

Payment Required 402

Since: 0.6.6

Forbidden 403

Forbidden 403

Not Found 404

Not Found 404

Method Not Allowed 405

Method Not Allowed 405

Not Acceptable 406

Since: 0.6.6

Not Acceptable 406

Since: 0.6.6

Proxy Authentication Required 407

Since: 0.6.6

Proxy Authentication Required 407

Since: 0.6.6

Request Timeout 408

Since: 0.6.6

Request Timeout 408

Since: 0.6.6

Conflict 409

Since: 0.6.6

Conflict 409

Since: 0.6.6

Gone 410

Since: 0.6.6

Gone 410

Since: 0.6.6

Length Required 411

Since: 0.6.6

Length Required 411

Since: 0.6.6

Precondition Failed 412

Since: 0.6.1

Precondition Failed 412

Since: 0.6.1

Request Entity Too Large 413

Since: 0.6.6

Request Entity Too Large 413

Since: 0.6.6

Request-URI Too Long 414

Since: 0.6.6

Request-URI Too Long 414

Since: 0.6.6

Unsupported Media Type 415

Since: 0.6.6

Unsupported Media Type 415

Since: 0.6.6

Requested Range Not Satisfiable 416

Since: 0.6.1

Requested Range Not Satisfiable 416

Since: 0.6.1

Expectation Failed 417

Since: 0.6.6

Expectation Failed 417

Since: 0.6.6

I'm a teapot 418

Since: 0.6.6

I'm a teapot 418

Since: 0.6.6

Unprocessable Entity 422 (RFC 4918)

Since: 0.9.1

Unprocessable Entity 422 (RFC 4918)

Since: 0.9.1

Precondition Required 428 (RFC 6585)

Since: 0.8.5

Precondition Required 428 (RFC 6585)

Since: 0.8.5

Too Many Requests 429 (RFC 6585)

Since: 0.8.5

Too Many Requests 429 (RFC 6585)

Since: 0.8.5

Request Header Fields Too Large 431 (RFC 6585)

Since: 0.8.5

Request Header Fields Too Large 431 (RFC 6585)

Since: 0.8.5

Internal Server Error 500

Internal Server Error 500

Not Implemented 501

Since: 0.6.1

Not Implemented 501

Since: 0.6.1

Bad Gateway 502

Since: 0.6.6

Bad Gateway 502

Since: 0.6.6

Service Unavailable 503

Since: 0.6.6

Service Unavailable 503

Since: 0.6.6

Gateway Timeout 504

Since: 0.6.6

Gateway Timeout 504

Since: 0.6.6

HTTP Version Not Supported 505

Since: 0.6.6

HTTP Version Not Supported 505

Since: 0.6.6

Network Authentication Required 511 (RFC 6585)

Since: 0.8.5

Network Authentication Required 511 (RFC 6585)

Since: 0.8.5

Informational class

Checks if the status is in the 1XX range.

Since: 0.8.0

Successful class

Checks if the status is in the 2XX range.

Since: 0.8.0

Redirection class

Checks if the status is in the 3XX range.

Since: 0.8.0

Client Error class

Checks if the status is in the 4XX range.

Since: 0.8.0

Server Error class

Checks if the status is in the 5XX range.

Since: 0.8.0

A full HTTP header field with the name and value separated.

E.g. "Content-Length: 28" parsed into a Header would turn into ("Content-Length", "28")

A case-insensitive name of a header field.

This is the part of the header field before the colon: HeaderName: some value

A list of Headers.

Same type as ResponseHeaders, but useful to differentiate in type signatures.

A list of Headers.

Same type as RequestHeaders, but useful to differentiate in type signatures.

Accept

Since: 0.7.0

Accept-Language

Since: 0.7.0

Authorization

Since: 0.7.0

Cache-Control

Since: 0.7.0

Cookie

Since: 0.7.0

Connection

Since: 0.7.0

Content-Encoding

Since: 0.7.0

Content-Length

Since: 0.7.0

Content-MD5

This header has been obsoleted in RFC 9110.

Since: 0.7.0

Content-Type

Since: 0.7.0

Date

Since: 0.7.0

If-Modified-Since

Since: 0.7.0

If-Range

Since: 0.7.0

Last-Modified

Since: 0.7.0

Location

Since: 0.7.1

Range

Since: 0.7.0

Referer

Since: 0.7.0

Server

Since: 0.7.1

User-Agent

Since: 0.7.0

An individual byte range.

Negative indices are not allowed!

Since: 0.6.11

Turns a byte range into a byte string Builder.

Since: 0.6.11

Renders a byte range into a ByteString.

>>> renderByteRange (ByteRangeFrom 2048)
"2048-"

Since: 0.6.11

A list of byte ranges.

Since: 0.6.11

Turns a list of byte ranges into a byte string Builder.

Since: 0.6.11

Renders a list of byte ranges into a ByteString.

>>> renderByteRanges [ByteRangeFrom 2048, ByteRangeSuffix 20]
"bytes=2048-,-20"

Since: 0.6.11

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]

Since: 0.9.1

A sequence of QueryItems.

An item from the query string, split up into two parts.

The second part should be Nothing if there was no key-value separator after the query item name.

Since: 0.2.0

Renders the given Query into a ByteString.

If you want a question mark (?) added to the front of the result, use True.

Since: 0.2.0

Renders the given Query into a Builder.

If you want a question mark (?) added to the front of the result, use True.

Since: 0.5

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".
• It decodes '+' characters to ' '

Since: 0.2.0

Same functionality as parseQuery, but with the option to decode '+' characters to ' ' or to preserve any '+' encountered.

If you want to replace any '+' with a space, use True.

Since: 0.12.2

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

Since: 0.5.2

Convert QueryText to Query.

Since: 0.5.2

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

Since: 0.5.2

Convert QueryText to a Builder.

If you want a question mark (?) added to the front of the result, use True.

Since: 0.5.2

Parse a QueryText from a ByteString. See parseQuery for details.

queryToQueryText . parseQuery

Since: 0.5.2

A sequence of SimpleQueryItems.

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

Since: 0.2.0

Convert SimpleQuery to Query.

Since: 0.5

Render the given SimpleQuery into a ByteString.

If you want a question mark (?) added to the front of the result, use True.

Since: 0.2.0

Parse SimpleQuery from a ByteString.

This uses parseQuery under the hood, and will transform any Nothing values into an empty ByteString.

Since: 0.2.0

Query with some characters that should not be escaped.

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

Since: 0.12.1

Partially escaped query item.

The key will always be encoded using 'urlEncode True', but the value will be encoded depending on which EscapeItems are used.

Since: 0.12.1

Section of a query item value that decides whether to use regular URL encoding (using 'urlEncode True') with QE, or to not encode anything with QN.

Since: 0.12.1

Convert PartialEscapeQuery to ByteString.

If you want a question mark (?) added to the front of the result, use True.

>>> renderQueryPartialEscape True [("a", [QN "x:z + ", QE (encodeUtf8 "They said: \"שלום\"")])]
"?a=x:z + They%20said%3A%20%22%D7%A9%D7%9C%D7%95%D7%9D%22"

Since: 0.12.1

Convert a PartialEscapeQuery to a Builder.

If you want a question mark (?) added to the front of the result, use True.

Since: 0.12.1

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.

Since: 0.7.0

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

Though a more accurate description of this function's behaviour is that it removes the domain/origin if the string starts with an HTTP protocol. (i.e. http:// or https://)

This function will not change anything when given any other ByteString. (except return a root path "/" if given an empty string)

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

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

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

>>> extractPath ""
"/"

>>> extractPath "www.google.com/some/path"
"www.google.com/some/path"

Since: 0.8.5

Encode a whole path (path segments + query).

Since: 0.5

Decode a whole path (path segments + query).

Since: 0.5

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

This function takes the following three steps:

• UTF-8 encodes the characters.
• Prepends each segment with a slash.

• Performs percent-encoding on all characters that are not:

  • alphanumeric (i.e. A-Z and a-z)
  • digits (i.e. 0-9)
  • a dash '-', an underscore '_', a dot '.', or a tilde '~'

For example:

>>> encodePathSegments ["foo", "bar1", "~baz"]
"/foo/bar1/~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.

Since: 0.5

Like encodePathSegments, but without the initial slash.

Since: 0.6.10

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

Will also decode any percent-encoded characters.

Since: 0.5

Percent-encoding for URLs.

In short:

• if you're encoding (parts of) a path element, use False.
• if you're encoding (parts of) a query string, use True.

In-depth explanation

Since: 0.2.0

Percent-encoding for URLs.

Like urlEncode, but only makes the Builder.

Since: 0.5

Percent-decoding.

If you want to replace any '+' with a space, use True.

Since: 0.2.0