wreq-0.5.3.3: An easy-to-use HTTP client library.
Copyright(c) 2014 Bryan O'Sullivan
LicenseBSD-style
Maintainerbos@serpentine.com
Stabilityexperimental
PortabilityGHC
Safe HaskellNone
LanguageHaskell98

Network.Wreq.Types

Description

HTTP client types.

Synopsis

Client configuration

data Options Source #

Options for configuring a client.

Constructors

Options 

Fields

Instances

Instances details
Show Options Source # 
Instance details

Defined in Network.Wreq.Internal.Types

data Auth Source #

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 (Maybe ByteString)

Amazon Web Services request signing AWSAuthVersion key secret (optional: session-token)

AWSFullAuth AWSAuthVersion ByteString ByteString (Maybe ByteString) (Maybe (ByteString, ByteString))

Amazon Web Services request signing AWSAuthVersion key secret Maybe (service, region)

OAuth1 ByteString ByteString ByteString ByteString

OAuth1 request signing OAuth1 consumerToken consumerSecret token secret

Instances

Instances details
Eq Auth Source # 
Instance details

Defined in Network.Wreq.Internal.Types

Methods

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

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

Show Auth Source # 
Instance details

Defined in Network.Wreq.Internal.Types

Methods

showsPrec :: Int -> Auth -> ShowS #

show :: Auth -> String #

showList :: [Auth] -> ShowS #

data AWSAuthVersion Source #

Constructors

AWSv4

AWS request signing version 4

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

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

Request payloads

data Payload where Source #

A product type for representing more complex payload types.

Constructors

Raw :: ContentType -> RequestBody -> Payload 

Instances

Instances details
Putable Payload Source # 
Instance details

Defined in Network.Wreq.Types

Postable Payload Source # 
Instance details

Defined in Network.Wreq.Types

class Postable a where Source #

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

Minimal complete definition

Nothing

Methods

postPayload :: a -> Request -> IO Request Source #

default postPayload :: Putable a => a -> Request -> IO Request Source #

Instances

Instances details
Postable ByteString Source # 
Instance details

Defined in Network.Wreq.Types

Postable ByteString Source # 
Instance details

Defined in Network.Wreq.Types

Postable Encoding Source # 
Instance details

Defined in Network.Wreq.Types

Postable Value Source # 
Instance details

Defined in Network.Wreq.Types

Postable Part Source # 
Instance details

Defined in Network.Wreq.Types

Postable FormParam Source # 
Instance details

Defined in Network.Wreq.Types

Postable Payload Source # 
Instance details

Defined in Network.Wreq.Types

Postable [(ByteString, ByteString)] Source # 
Instance details

Defined in Network.Wreq.Types

Postable [Part] Source # 
Instance details

Defined in Network.Wreq.Types

Postable [FormParam] Source # 
Instance details

Defined in Network.Wreq.Types

Postable (ByteString, ByteString) Source # 
Instance details

Defined in Network.Wreq.Types

class Putable a where Source #

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

Methods

putPayload :: a -> Request -> IO Request Source #

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

Instances

Instances details
Putable ByteString Source # 
Instance details

Defined in Network.Wreq.Types

Putable ByteString Source # 
Instance details

Defined in Network.Wreq.Types

Putable Encoding Source # 
Instance details

Defined in Network.Wreq.Types

Putable Value Source # 
Instance details

Defined in Network.Wreq.Types

Putable Part Source # 
Instance details

Defined in Network.Wreq.Types

Putable FormParam Source # 
Instance details

Defined in Network.Wreq.Types

Putable Payload Source # 
Instance details

Defined in Network.Wreq.Types

Putable [(ByteString, ByteString)] Source # 
Instance details

Defined in Network.Wreq.Types

Putable [Part] Source # 
Instance details

Defined in Network.Wreq.Types

Putable [FormParam] Source # 
Instance details

Defined in Network.Wreq.Types

Putable (ByteString, ByteString) Source # 
Instance details

Defined in Network.Wreq.Types

URL-encoded forms

data FormParam where Source #

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

Constructors

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

Instances

Instances details
Show FormParam Source # 
Instance details

Defined in Network.Wreq.Internal.Types

Putable FormParam Source # 
Instance details

Defined in Network.Wreq.Types

Postable FormParam Source # 
Instance details

Defined in Network.Wreq.Types

Putable [FormParam] Source # 
Instance details

Defined in Network.Wreq.Types

Postable [FormParam] Source # 
Instance details

Defined in Network.Wreq.Types

class FormValue a where Source #

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.

Methods

renderFormValue :: a -> ByteString Source #

Render the given value.

Instances

Instances details
FormValue Double Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Float Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Int Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Int8 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Int16 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Int32 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Int64 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Integer Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Word Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Word8 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Word16 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Word32 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Word64 Source # 
Instance details

Defined in Network.Wreq.Types

FormValue () Source # 
Instance details

Defined in Network.Wreq.Types

FormValue ByteString Source # 
Instance details

Defined in Network.Wreq.Types

FormValue ByteString Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Builder Source # 
Instance details

Defined in Network.Wreq.Types

FormValue String Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Text Source # 
Instance details

Defined in Network.Wreq.Types

FormValue Text Source # 
Instance details

Defined in Network.Wreq.Types

FormValue a => FormValue (Maybe a) Source # 
Instance details

Defined in Network.Wreq.Types

Headers

type ContentType = ByteString Source #

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

data Link Source #

An element of a Link header.

Constructors

Link 

Instances

Errors

data JSONError Source #

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

Constructors

JSONError String 

Request handling

data Req Source #

A request that is ready to be submitted.

reqURL :: Req -> ByteString Source #

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) Source #

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

Orphan instances

FormValue Double Source # 
Instance details

FormValue Float Source # 
Instance details

FormValue Int Source # 
Instance details

FormValue Int8 Source # 
Instance details

FormValue Int16 Source # 
Instance details

FormValue Int32 Source # 
Instance details

FormValue Int64 Source # 
Instance details

FormValue Integer Source # 
Instance details

FormValue Word Source # 
Instance details

FormValue Word8 Source # 
Instance details

FormValue Word16 Source # 
Instance details

FormValue Word32 Source # 
Instance details

FormValue Word64 Source # 
Instance details

FormValue () Source # 
Instance details

FormValue ByteString Source # 
Instance details

FormValue ByteString Source # 
Instance details

FormValue Builder Source # 
Instance details

FormValue String Source # 
Instance details

FormValue Text Source # 
Instance details

FormValue Text Source # 
Instance details

Putable ByteString Source # 
Instance details

Putable ByteString Source # 
Instance details

Putable Encoding Source # 
Instance details

Putable Value Source # 
Instance details

Putable Part Source # 
Instance details

Putable FormParam Source # 
Instance details

Putable Payload Source # 
Instance details

Postable ByteString Source # 
Instance details

Postable ByteString Source # 
Instance details

Postable Encoding Source # 
Instance details

Postable Value Source # 
Instance details

Postable Part Source # 
Instance details

Postable FormParam Source # 
Instance details

Postable Payload Source # 
Instance details

FormValue a => FormValue (Maybe a) Source # 
Instance details

Putable [(ByteString, ByteString)] Source # 
Instance details

Putable [Part] Source # 
Instance details

Putable [FormParam] Source # 
Instance details

Postable [(ByteString, ByteString)] Source # 
Instance details

Postable [Part] Source # 
Instance details

Postable [FormParam] Source # 
Instance details

Putable (ByteString, ByteString) Source # 
Instance details

Postable (ByteString, ByteString) Source # 
Instance details