HTTP module:Network package:req

HTTP

Given host name, produce a Url which has “http” as its scheme and empty path. This also sets port to 80.

A type class for things that can be interpreted as an HTTP RequestBody.

This type function allows any HTTP body if method says it CanHaveBody. When the method says it should have NoBody, the only body option to use is NoReqBody.

HttpConfig contains settings to be used when making HTTP requests.

Exceptions that this library throws.

A type class for types that can be used as an HTTP method. To define a non-standard method, follow this example that defines COPY:

data COPY = COPY

instance HttpMethod COPY where
type AllowsBody COPY = 'CanHaveBody
httpMethodName Proxy = "COPY"

A type class for response interpretations. It allows us to describe how to consume the response from a Response BodyReader and produce the final result that is to be returned to the user.

HTTPS

Alternative Manager to use. Nothing (default value) means that the default implicit manager will be used (that's what you want in 99% of cases).

Max length of preview fragment of response body.

Function to check the response immediately after receiving the status and headers, before streaming of response body. The third argument is the beginning of response body (typically first 1024 bytes). This is used for throwing exceptions on non-success status codes by default (set to \_ _ _ -> Nothing if this behavior is not desirable). When the value this function returns is Nothing, nothing will happen. When it there is HttpExceptionContent inside Just, it will be thrown. Throwing is better then just returning a request with non-2xx status code because in that case something is wrong and we need a way to short-cut execution (also remember that Req retries automatically on request timeouts and such, so when your request fails, it's certainly something exceptional). The thrown exception is caught by the library though and is available in handleHttpException. Note: signature of this function was changed in the version 1.0.0.

Proxy to use. By default values of HTTP_PROXY and HTTPS_PROXY environment variables are respected, this setting overwrites them. Default value: Nothing.

How many redirects to follow when getting a resource. Default value: 10.

The function is used to decide whether to retry a request. True means that the request should be retried. Note: signature of this function was changed in the version 1.0.0.

Similar to httpConfigRetryJudge, but is used to decide when to retry requests that resulted in an exception. By default it retries on response timeout and connection timeout (changed in version 3.8.0).

The retry policy to use for request retrying. By default def is used (see RetryPolicyM). Note: signature of this function was changed to disallow IO in version 1.0.0 and then changed back to its current form in 3.1.0.

Return name of the method as a ByteString.

HTTP version to send to the server, the default is HTTP 1.1.

Given host name, produce a Url which has “https” as its scheme and empty path. This also sets port to 443.

A wrapper with Aeson-produced String describing why decoding failed

A type class for monads that support performing HTTP requests. Typically, you only need to define the handleHttpException method unless you want to tweak HttpConfig.

A wrapper with an HttpException from Network.HTTP.Client

The default value of HttpConfig.