Network.HTTP.Types.Exchange

data Auth

A type that represents an HTTP Authentication Scheme.

Constructors

• BasicAuth (Maybe String) (Maybe String)

Instances

• Show Auth

newtype Request

A type that represents an HTTP Request.

Constructors

• Request { auth :: Maybe Auth, body :: String, cookies :: List Cookie, headers :: Headers, method :: Method, timeout :: Maybe Milliseconds, uri :: URI }

Instances

• Show Request

newtype Response

A type that represents an HTTP Response.

Constructors

• Response { body :: String, cookies :: List Cookie, headers :: Headers, statusCode :: StatusCode }

Instances

• Show Response

http :: URIScheme

A URIScheme set to http:.

https :: URIScheme

A URIScheme set to https:.

defURI :: URI

A 'default' base url useful for constructing requests. Equivalent to http://localhost:80/.

defRequest :: { auth :: Maybe Auth, body :: String, cookies :: List Cookie, headers :: Headers, method :: Method, timeout :: Maybe Milliseconds, uri :: URI }

A 'default' record useful for constructing requests. Equivalent to a request that is sent to http://localhost:80/ with the GET method, no headers, cookies, authentication, body or timeout.

defRequest' :: Request

A 'default' request useful for constructing requests. It wraps the 'defRequest' record with the 'Request' constructor.

makeQuery :: String -> String -> Query

Constructs a query string from a pair (e.g.: makeQuery animal cat == ?animal=cat).

makeQuery' :: String -> Query

Constructs a query string from a single string (e.g.: makeQuery' hungry == ?hungry).

joinQuery :: Query -> Query -> Query

Kinda-sorta like a Monoid over Query; combines two queries (e.q.: joinQuery (?animal=cat) (?hungry) == ?hungry&animal=cat).

basicAuth :: String -> String -> Auth

Constructs a 'BasicAuth' from two strings. The same as the constructor, only it wraps the strings in Just first.

setUser :: String -> Auth -> Auth

setPassword :: String -> Auth -> Auth

setProtocol :: URIScheme -> Request -> Request

setHostname :: Host -> Request -> Request

setPort :: Port -> Request -> Request

modifyPath :: (URIPathAbs -> URIPathAbs) -> Request -> Request

setPath :: URIPathAbs -> Request -> Request

modifyQuery :: (Query -> Query) -> Request -> Request

setQuery :: Query -> Request -> Request

modifyFragment :: (Fragment -> Fragment) -> Request -> Request

setFragment :: Fragment -> Request -> Request

setURI :: URI -> Request -> Request

setMethod :: Method -> Request -> Request

setHeaders :: Headers -> Request -> Request

setCookies :: List Cookie -> Request -> Request

setAuth :: Auth -> Request -> Request

setBody :: String -> Request -> Request

setTimeout :: Milliseconds -> Request -> Request

uriToRequest' :: URI -> Request

Constructs a 'Request' from a 'URI'. The request has all of the values of 'defRequest', with the URI set to the passed parameter.

uriToRequest :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter. If the uri string could not be parsed, the parsing error is thrown.

uriToRequest'' :: String -> Maybe Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter. If the uri string could not be parsed, Nothing is returned.

get :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter, and the method set to GET. If the uri string could not be parsed, the parsing error is thrown.

post :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter, and the method set to POST. If the uri string could not be parsed, the parsing error is thrown.

postWithBody :: forall m. MonadError Error m => String -> String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed uri, the method set to POST, and the request body equal to passed body. If the uri string could not be parsed, the parsing error is thrown.

put :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter, and the method set to PUT. If the uri string could not be parsed, the parsing error is thrown.

putWithBody :: forall m. MonadError Error m => String -> String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed uri, the method set to PUT, and the request body equal to passed body. If the uri string could not be parsed, the parsing error is thrown.

patch :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter, and the method set to PATCH. If the uri string could not be parsed, the parsing error is thrown.

patchWithBody :: forall m. MonadError Error m => String -> String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed uri, the method set to PATCH, and the request body equal to passed body. If the uri string could not be parsed, the parsing error is thrown.

delete :: forall m. MonadError Error m => String -> m Request

Constructs a 'Request' from a uri string. The request has all of the values of 'defRequest', with the URI set to the passed parameter, and the method set to DELETE. If the uri string could not be parsed, the parsing error is thrown.

setResponseStatusCode :: StatusCode -> Response -> Response

setResponseHeaders :: Headers -> Response -> Response

setResponseBody :: String -> Response -> Response

setResponseCookies :: List Cookie -> Response -> Response

fromJSONWith :: forall e a m. MonadError Error m => Show e => (String -> Either e a) -> Response -> m a

Takes a completed 'Response', extracts its string body, and converts that to our desired type using the given function. Throws an error if the conversion fails.

The given function is expected to take the string body, and return a Show errmsg => Left errmsg if the conversion fails, or a Right a if the conversion is successful.