Network.Wreq.Types

Either configuration for a Manager, or an actual Manager.

If only ManagerSettings are provided, then by default a new Manager will be created for each request.

Note: when issuing HTTP requests using Options-based functions from the the Network.Wreq.Session module (getWith, putWith, etc.), this field will be ignored.

An example of using a specific manager:

import Network.HTTP.Client (withManager)

withManager $ \mgr -> do
  let opts = defaults { manager = Right mgr }
  getWith opts "http://httpbin.org/get"
 

An example of changing settings (this will use a separate Manager for every request, so make sense only if you're issuing a tiny handful of requets):

import Network.HTTP.Client (defaultManagerSettings)

let settings = defaultManagerSettings { managerConnCount = 5 }
    opts = defaults { manager = Left settings }
getWith opts "http://httpbin.org/get"
 

Host name and port for a proxy to use, if any.

Authentication information.

Example (note the use of TLS):

let opts = defaults { auth = basicAuth "user" "pass" }
getWith opts "https://httpbin.org/basic-auth/user/pass"
 

Additional headers to send with each request.

let opts = defaults { headers = [("Accept", "*/*")] }
getWith opts "http://httpbin.org/get"
 

Key-value pairs to assemble into a query string to add to the end of a URL.

For example, given:

let opts = defaults { params = [("sort", "ascending"), ("key", "name")] }
getWith opts "http://httpbin.org/get"
 

This will generate a URL of the form:

http://httpbin.org/get?sort=ascending&key=name

The maximum number of HTTP redirects to follow before giving up and throwing an exception.

In this example, a HttpException will be thrown with a TooManyRedirects constructor, because the maximum number of redirects allowed will be exceeded:

let opts = defaults { redirects = 3 }
getWith opts "http://httpbin.org/redirect/5"
 

Cookies to set when issuing requests.

Note: when issuing HTTP requests using Options-based functions from the the Network.Wreq.Session module (getWith, putWith, etc.), this field will be used only for the first HTTP request to be issued during a Session. Any changes changes made for subsequent requests will be ignored.

Function that checks the status code and potentially returns an exception.

This defaults to Nothing, which will just use the default of Request which throws a StatusException if the status is not 2XX.