Model of an HTTP request with type parameters: scheme describing the uri scheme, body describing the type of the content body, contentTag describing the type, method describing the HTTP verb associated with the request, contentTag describing the type of content being sen and acceptTag describing the type of content desired

Model of an HTTP response with the type parameter body describing the type of the content body.

Create an HTTP DELETE request with the supplied URI, containing no body and no headers

Create an HTTP GET request with the supplied URI, containing no body and no headers

Create an HTTP HEAD request with the supplied URI, containing no body and no headers

Create an HTTP PATCH request with the supplied URI, containing no body and no headers

Create an HTTP POST request with the supplied URI, containing no body and no headers

Create an HTTP PUT request with the supplied URI, containing no body and no headers

Supply a body to an HTTP request using the supplied tag to indicate how the request should be encoded

Apply an accept header derived from the supplied tag proxy and add a type hint to the request, indicating how the response should be decodable

Make the supplied HTTP request, expecting an HTTP response in the supplied format with body type b to be delivered in some 'MonadDormouseClient m'

Make the supplied HTTP request, expecting an HTTP response with body type b to be delivered in some 'MonadDormouseClient m'

The DormouseClientT Monad Transformer

A simple monad that allows you to run DormouseClient

Run a DormouseClientT using the supplied DormouseClientConfig to generate a result in the underlying monad m

Run a DormouseClient using the supplied DormouseClientConfig to generate a result in IO

MonadDormouseClient describes the capability to send HTTP requests and receive an HTTP response

Create a Manager. The Manager will be shut down automatically via garbage collection.

Creating a new Manager is a relatively expensive operation, you are advised to share a single Manager between requests instead.

The first argument to this function is often defaultManagerSettings, though add-on libraries may provide a recommended replacement.

Since 0.1.0

Default TLS-enabled manager settings

Describes the capability to retrieve a Dormouse Config

The configuration options required to run Dormouse

The name of an HTTP Header. Header names are case insensitive.

Describes something which has headers

Describes an association between a type tag and a specific Media Type

A raw HTTP Request payload consisting of a stream of bytes with either a defined Content Length or using Chunked Transfer Encoding

RequestPayload relates a type of content and a payload tag used to describe that type to its byte stream representation and the constraints required to encode it

ResponsePayload relates a type of content and a payload tag used to describe that type to its byte stream representation and the constraints required to decode it

A type tag used to indicate that a request/response should be encoded/decoded as application/json data

A type tag used to indicate that a request/response should be encoded/decoded as application/x-www-form-urlencoded data

A type tag used to indicate that a request/response has no payload

A type tag used to indicate that a request/response should be encoded/decoded as text/html data

DecodingException is used to when something has gone wrong decoding an http response into the expected representation, e.g. json was expected but the response json was invalid.

MediaTypeException is used to indicate an error parsing a MediaType header such as "Content-Type" into a valid MediaType

UnexpectedStatusCodeException is used to indicate that the remote server returned an unexpected status code value, for instance an unsuccessful (non-2XX) status code.

UriException is used to indicate an error parsing a URI

UrlException is used to indicate an error in transforming a valid URI into a URL, e.g. the URI refers to a different schema such as file

A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. It is defined according to RFC 3986 (https://tools.ietf.org/html/rfc3986).

Parse an ascii ByteString as a uri, throwing a UriException in m if this fails

A Url is defined here as an absolute URI in the http or https schemes. Authority components are requried by the http / https Uri schemes.

AnyUrl is a wrapper aroud Url which allows either http or https urls.

Ensure that the supplied Url uses the _http_ scheme, throwing a UrlException in m if this is not the case

Ensure that the supplied Url uses the _https_ scheme, throwing a UrlException in m if this is not the case

Parse an ascii ByteString as a url, throwing a UriException in m if this fails

Parse an ascii ByteString as an http url, throwing a UriException in m if this fails

Parse an ascii ByteString as an https url, throwing a UriException in m if this fails