| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Http
Description
Making HTTP requests using an API inspired by Elm's elm/http.
Synopsis
- data Handler
- handler :: Acquire Handler
- get :: (Typeable x, Typeable a) => Handler -> Text -> Expect' x a -> Task x a
- post :: (Typeable x, Typeable a) => Handler -> Text -> Body -> Expect' x a -> Task x a
- request :: (Typeable x, Typeable expect) => Handler -> Request' x expect -> Task x expect
- data Request' x a = Request {}
- type Request a = Request' Error a
- data Error
- data Header
- header :: Text -> Text -> Header
- data Body
- emptyBody :: Body
- stringBody :: Text -> Text -> Body
- jsonBody :: ToJSON body => body -> Body
- bytesBody :: Text -> ByteString -> Body
- type Expect a = Expect' Error a
- expectJson :: FromJSON a => Expect a
- expectText :: Expect Text
- expectWhatever :: Expect ()
- data Expect' x a
- expectTextResponse :: (Response Text -> Result x a) -> Expect' x a
- expectBytesResponse :: (Response ByteString -> Result x a) -> Expect' x a
- data Response body
- = BadUrl_ Text
- | Timeout_
- | NetworkError_ Text
- | BadStatus_ Metadata body
- | GoodStatus_ Metadata body
- data Metadata = Metadata {}
- withThirdParty :: Handler -> (Manager -> Task e a) -> Task e a
- withThirdPartyIO :: LogHandler -> Handler -> (Manager -> IO a) -> IO a
Handlers
Requests
get :: (Typeable x, Typeable a) => Handler -> Text -> Expect' x a -> Task x a Source #
Create a GET request.
post :: (Typeable x, Typeable a) => Handler -> Text -> Body -> Expect' x a -> Task x a Source #
Create a POST request.
request :: (Typeable x, Typeable expect) => Handler -> Request' x expect -> Task x expect Source #
Create a custom request.
A custom request.
Constructors
| Request | |
Fields
| |
A Request can fail in a couple of ways:
BadUrlmeans you did not provide a valid URL.Timeoutmeans it took too long to get a response.NetworkErrormeans the user turned off their wifi, went in a cave, etc.BadStatusmeans you got a response back, but the status code indicates failure.BadBodymeans you got a response back with a nice status code, but the body of the response was something unexpected. TheTextin this cse is the debugging message that explains what went wrong with your JSONT decoder or whatever.
Instances
Header
An HTTP header for configuration requests.
Body
Create an empty body for your Request. This is useful for GET requests and POST requests where you are not sending any data.
stringBody :: Text -> Text -> Body Source #
Put some string in the body of your Request.
The first argument is a MIME type of the body. Some servers are strict about this!
jsonBody :: ToJSON body => body -> Body Source #
Put some JSON value in the body of your Request. This will automatically add the Content-Type: application/json header.
bytesBody :: Text -> ByteString -> Body Source #
Put some Bytes in the body of your Request. This allows you to use ByteString to have full control over the binary representation of the data you are sending.
The first argument is a MIME type of the body. In other scenarios you may want to use MIME types like imagepng or imagejpeg instead.
Expect
type Expect a = Expect' Error a Source #
A simple logic for interpreting a response body with the built-in Error type.
expectJson :: FromJSON a => Expect a Source #
Expect the response body to be JSON.
expectWhatever :: Expect () Source #
Expect the response body to be whatever. It does not matter. Ignore it!
Elaborate Expectations
expectTextResponse :: (Response Text -> Result x a) -> Expect' x a Source #
Expect a Response with a Text body.
expectBytesResponse :: (Response ByteString -> Result x a) -> Expect' x a Source #
Expect a Response with a ByteString body
A Response can come back a couple different ways:
BadUrl_— you did not provide a valid URL.Timeout_— it took too long to get a response.NetworkError_— the user turned off their wifi, went in a cave, etc.BadStatus_— a response arrived, but the status code indicates failure.GoodStatus_— a response arrived with a nice status code!- The type of the body depends on whether you use expectStringResponse or expectBytesResponse.
Constructors
| BadUrl_ Text | |
| Timeout_ | |
| NetworkError_ Text | |
| BadStatus_ Metadata body | |
| GoodStatus_ Metadata body |
Instances
Constructors
| Metadata | |
Fields | |
Instances
| Eq Metadata Source # | |
| Show Metadata Source # | |
| Generic Metadata Source # | |
| ToJSON Metadata Source # | |
Defined in Http.Internal | |
| type Rep Metadata Source # | |
Defined in Http.Internal type Rep Metadata = D1 ('MetaData "Metadata" "Http.Internal" "nri-http-0.3.0.0-inplace" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadataStatusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "metadataStatusText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "metadataHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Dict Text Text))))) | |
Use with external libraries
withThirdParty :: Handler -> (Manager -> Task e a) -> Task e a Source #
Third party libraries that make HTTP requests often take a Manager.
This helper allows us to call such a library using a Handler.
The benefit over using this over using a separate Manager for the
external library, is that withThirdParty will ensure HTTP requests made
by the external library will get logged.
withThirdPartyIO :: LogHandler -> Handler -> (Manager -> IO a) -> IO a Source #
Like withThirdParty, but runs in IO.