Network.Wreq.Types

HTTP client types.

Client configuration

data Options

Options for configuring a client.

Constructors

Options

Fields

• manager :: Mgr

  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"
   

• proxy :: Maybe Proxy

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

• auth :: Maybe Auth

  Authentication information.

  Example (note the use of TLS):

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

• headers :: [Header]

  Additional headers to send with each request.

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

• params :: [(Text, Text)]

  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

• redirects :: Int

  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 :: Maybe CookieJar

  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.

• checkResponse :: Maybe ResponseChecker

  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.

Instances

Show Options

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data Auth

Supported authentication types.

Do not use HTTP authentication unless you are using TLS encryption. These authentication tokens can easily be captured and reused by an attacker if transmitted in the clear.

Constructors

BasicAuth ByteString ByteString

Basic authentication. This consists of a plain username and password.

OAuth2Bearer ByteString

An OAuth2 bearer token. This is treated by many services as the equivalent of a username and password.

OAuth2Token ByteString

A not-quite-standard OAuth2 bearer token (that seems to be used only by GitHub). This is treated by whoever accepts it as the equivalent of a username and password.

AWSAuth AWSAuthVersion ByteString ByteString

Amazon Web Services request signing AWSAuthVersion key secret

OAuth1 ByteString ByteString ByteString ByteString

OAuth1 request signing OAuth1 consumerToken consumerSecret token secret

Instances

Eq Auth

Methods

(==) :: Auth -> Auth -> Bool

(/=) :: Auth -> Auth -> Bool

Show Auth

Methods

showsPrec :: Int -> Auth -> ShowS

show :: Auth -> String

showList :: [Auth] -> ShowS

data AWSAuthVersion

Constructors

AWSv4

AWS request signing version 4

Instances

Eq AWSAuthVersion

Methods

(==) :: AWSAuthVersion -> AWSAuthVersion -> Bool

(/=) :: AWSAuthVersion -> AWSAuthVersion -> Bool

Show AWSAuthVersion

Methods

showsPrec :: Int -> AWSAuthVersion -> ShowS

show :: AWSAuthVersion -> String

showList :: [AWSAuthVersion] -> ShowS

type ResponseChecker = Request -> Response BodyReader -> IO ()

A function that checks the result of a HTTP request and potentially returns an exception.

Request payloads

data Payload where

A product type for representing more complex payload types.

Constructors

Raw :: ContentType -> RequestBody -> Payload

class Postable a where

A type that can be converted into a POST request payload.

Minimal complete definition

postPayload

Methods

postPayload :: a -> Request -> IO Request

Represent a value in the request body (and perhaps the headers) of a POST request.

class Putable a where

A type that can be converted into a PUT request payload.

Minimal complete definition

putPayload

Methods

putPayload :: a -> Request -> IO Request

Represent a value in the request body (and perhaps the headers) of a PUT request.

URL-encoded forms

data FormParam where

A key/value pair for an application/x-www-form-urlencoded POST request body.

Constructors

(:=) :: FormValue v => ByteString -> v -> FormParam infixr 3

Instances

Show FormParam

Methods

showsPrec :: Int -> FormParam -> ShowS

show :: FormParam -> String

showList :: [FormParam] -> ShowS

class FormValue a where

A type that can be rendered as the value portion of a key/value pair for use in an application/x-www-form-urlencoded POST body. Intended for use with the FormParam type.

The instances for String, strict Text, and lazy Text are all encoded using UTF-8 before being URL-encoded.

The instance for Maybe gives an empty string on Nothing, and otherwise uses the contained type's instance.

Minimal complete definition

renderFormValue

Methods

renderFormValue :: a -> ByteString

Render the given value.

Headers

type ContentType = ByteString

A MIME content type, e.g. "application/octet-stream".

data Link

An element of a Link header.

Constructors

Link

Fields

• linkURL :: ByteString
• linkParams :: [(ByteString, ByteString)]

Instances

Eq Link

Methods

(==) :: Link -> Link -> Bool

(/=) :: Link -> Link -> Bool

Show Link

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

Errors

data JSONError

The error type used by asJSON and asValue if a failure occurs when parsing a response body as JSON.

Constructors

JSONError String

Instances

Show JSONError

Methods

showsPrec :: Int -> JSONError -> ShowS

show :: JSONError -> String

showList :: [JSONError] -> ShowS

Exception JSONError

Methods

toException :: JSONError -> SomeException

fromException :: SomeException -> Maybe JSONError

displayException :: JSONError -> String

Request handling

data Req

A request that is ready to be submitted.

reqURL :: Req -> ByteString

Return the URL associated with the given Req.

This includes the port number if not standard, and the query string if one exists.

type Run body = Req -> IO (Response body)

A function that runs a request and returns the associated response.

Orphan instances

FormValue Double

Methods

renderFormValue :: Double -> ByteString

FormValue Float

Methods

renderFormValue :: Float -> ByteString

FormValue Int

Methods

renderFormValue :: Int -> ByteString

FormValue Int8

Methods

renderFormValue :: Int8 -> ByteString

FormValue Int16

Methods

renderFormValue :: Int16 -> ByteString

FormValue Int32

Methods

renderFormValue :: Int32 -> ByteString

FormValue Int64

Methods

renderFormValue :: Int64 -> ByteString

FormValue Integer

Methods

renderFormValue :: Integer -> ByteString

FormValue Word

Methods

renderFormValue :: Word -> ByteString

FormValue Word8

Methods

renderFormValue :: Word8 -> ByteString

FormValue Word16

Methods

renderFormValue :: Word16 -> ByteString

FormValue Word32

Methods

renderFormValue :: Word32 -> ByteString

FormValue Word64

Methods

renderFormValue :: Word64 -> ByteString

FormValue ()

Methods

renderFormValue :: () -> ByteString

FormValue ByteString

Methods

renderFormValue :: ByteString -> ByteString

FormValue ByteString

Methods

renderFormValue :: ByteString -> ByteString

FormValue Builder

Methods

renderFormValue :: Builder -> ByteString

FormValue String

Methods

renderFormValue :: String -> ByteString

FormValue Text

Methods

renderFormValue :: Text -> ByteString

FormValue Text

Methods

renderFormValue :: Text -> ByteString

Putable ByteString

Methods

putPayload :: ByteString -> Request -> IO Request

Putable ByteString

Methods

putPayload :: ByteString -> Request -> IO Request

Putable Value

Methods

putPayload :: Value -> Request -> IO Request

Putable Payload

Methods

putPayload :: Payload -> Request -> IO Request

Postable ByteString

Methods

postPayload :: ByteString -> Request -> IO Request

Postable ByteString

Methods

postPayload :: ByteString -> Request -> IO Request

Postable Value

Methods

postPayload :: Value -> Request -> IO Request

Postable Part

Methods

postPayload :: Part -> Request -> IO Request

Postable FormParam

Methods

postPayload :: FormParam -> Request -> IO Request

Postable Payload

Methods

postPayload :: Payload -> Request -> IO Request

FormValue a => FormValue (Maybe a)

Methods

renderFormValue :: Maybe a -> ByteString

Postable [(ByteString, ByteString)]

Methods

postPayload :: [(ByteString, ByteString)] -> Request -> IO Request

Postable [Part]

Methods

postPayload :: [Part] -> Request -> IO Request

Postable [FormParam]

Methods

postPayload :: [FormParam] -> Request -> IO Request

Postable (ByteString, ByteString)

Methods

postPayload :: (ByteString, ByteString) -> Request -> IO Request