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 StatusChecker = Status -> ResponseHeaders -> CookieJar -> Maybe SomeException
- data Payload where
- Raw :: ContentType -> RequestBody -> Payload
- class Postable a where
- postPayload :: a -> Request -> IO Request
- class Putable a where
- putPayload :: a -> Request -> IO Request
- data FormParam where
- (:=) :: FormValue v => ByteString -> v -> FormParam
- class FormValue a where
- renderFormValue :: a -> ByteString
- 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
data Options
Options for configuring a client.
Options | |
|
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.
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 |
type StatusChecker = Status -> ResponseHeaders -> CookieJar -> Maybe SomeException
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.
Raw :: ContentType -> RequestBody -> Payload |
class Postable a where
A type that can be converted into a POST request payload.
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.
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.
(:=) :: FormValue v => ByteString -> v -> FormParam infixr 3 |
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.
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.
Link | |
|
Errors
data JSONError
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.