Copyright | (c) 2014 Bryan O'Sullivan |
---|---|
License | BSD-style |
Maintainer | bos@serpentine.com |
Stability | experimental |
Portability | GHC |
Safe Haskell | None |
Language | Haskell98 |
HTTP client types.
- data Options = Options {}
- data Auth
- data AWSAuthVersion = AWSv4
- type ResponseChecker = Request -> Response BodyReader -> IO ()
- data Payload where
- Raw :: ContentType -> RequestBody -> Payload
- class Postable a where
- class Putable a where
- data FormParam where
- (:=) :: FormValue v => ByteString -> v -> FormParam
- class FormValue a where
- type ContentType = ByteString
- data Link = Link {
- linkURL :: ByteString
- linkParams :: [(ByteString, ByteString)]
- data JSONError = JSONError String
- data Req
- reqURL :: Req -> ByteString
- type Run body = Req -> IO (Response body)
Client configuration
Options for configuring a client.
Options | |
|
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.
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) |
OAuth1 ByteString ByteString ByteString ByteString | OAuth1 request signing OAuth1 consumerToken consumerSecret token secret |
data AWSAuthVersion Source #
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
A product type for representing more complex payload types.
Raw :: ContentType -> RequestBody -> Payload |
URL-encoded forms
A key/value pair for an application/x-www-form-urlencoded
POST request body.
(:=) :: FormValue v => ByteString -> v -> FormParam infixr 3 |
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.
renderFormValue :: a -> ByteString Source #
Render the given value.
Headers
type ContentType = ByteString Source #
A MIME content type, e.g. "application/octet-stream"
.
An element of a Link
header.
Link | |
|
Errors
Request handling
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.