Servant.Client.Internal.HttpClient.Streaming

Documentation

newtype ClientM a

ClientM is the monad in which client functions run. Contains the Manager and BaseUrl used for requests in the reader environment.

Constructors

ClientM

Fields

• unClientM :: ReaderT ClientEnv (ExceptT ClientError (Codensity IO)) a

Instances

Monad ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

(>>=) :: ClientM a -> (a -> ClientM b) -> ClientM b

(>>) :: ClientM a -> ClientM b -> ClientM b

return :: a -> ClientM a

Functor ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

fmap :: (a -> b) -> ClientM a -> ClientM b

(<$) :: a -> ClientM b -> ClientM a

Applicative ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

pure :: a -> ClientM a

(<*>) :: ClientM (a -> b) -> ClientM a -> ClientM b

liftA2 :: (a -> b -> c) -> ClientM a -> ClientM b -> ClientM c

(*>) :: ClientM a -> ClientM b -> ClientM b

(<*) :: ClientM a -> ClientM b -> ClientM a

MonadIO ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

liftIO :: IO a -> ClientM a

Alt ClientM

Try clients in order, last error is preserved.

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

(<!>) :: ClientM a -> ClientM a -> ClientM a

some :: Applicative ClientM => ClientM a -> ClientM [a]

many :: Applicative ClientM => ClientM a -> ClientM [a]

RunClient ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> ClientM Response

throwClientError :: ClientError -> ClientM a

RunStreamingClient ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

withStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a

MonadReader ClientEnv ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

ask :: ClientM ClientEnv

local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a

reader :: (ClientEnv -> a) -> ClientM a

MonadBase IO ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

liftBase :: IO α -> ClientM α

MonadError ClientError ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

throwError :: ClientError -> ClientM a

catchError :: ClientM a -> (ClientError -> ClientM a) -> ClientM a

Generic (ClientM a)

Defined in Servant.Client.Internal.HttpClient.Streaming

Associated Types

type Rep (ClientM a) :: Type -> Type

Methods

from :: ClientM a -> Rep (ClientM a) x

to :: Rep (ClientM a) x -> ClientM a

type Rep (ClientM a)

Defined in Servant.Client.Internal.HttpClient.Streaming

type Rep (ClientM a) = D1 ('MetaData "ClientM" "Servant.Client.Internal.HttpClient.Streaming" "servant-client-0.19-4XfiUnw8phL3FN0CLXBM6o" 'True) (C1 ('MetaCons "ClientM" 'PrefixI 'True) (S1 ('MetaSel ('Just "unClientM") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReaderT ClientEnv (ExceptT ClientError (Codensity IO)) a))))

client :: HasClient ClientM api => Proxy api -> Client ClientM api

Generates a set of client functions for an API.

Example:

type API = Capture "no" Int :> Get '[JSON] Int
       :<|> Get '[JSON] [Bool]

api :: Proxy API
api = Proxy

getInt :: Int -> ClientM Int
getBools :: ClientM [Bool]
getInt :<|> getBools = client api

hoistClient :: HasClient ClientM api => Proxy api -> (forall a. m a -> n a) -> Client m api -> Client n api

Change the monad the client functions live in, by supplying a conversion function (a natural transformation to be precise).

For example, assuming you have some manager :: Manager and baseurl :: BaseUrl around:

type API = Get '[JSON] Int :<|> Capture "n" Int :> Post '[JSON] Int
api :: Proxy API
api = Proxy
getInt :: IO Int
postInt :: Int -> IO Int
getInt :<|> postInt = hoistClient api (flip runClientM cenv) (client api)
  where cenv = mkClientEnv manager baseurl

withClientM :: ClientM a -> ClientEnv -> (Either ClientError a -> IO b) -> IO b

runClientM :: NFData a => ClientM a -> ClientEnv -> IO (Either ClientError a)

A runClientM variant for streaming client.

It allows using this module's ClientM in a direct style. The NFData constraint however prevents using this function with genuine streaming response types (SourceT, Conduit, pipes Proxy or Machine). For those you have to use withClientM.

Note: we force the result, so the likelihood of accidentally leaking a connection is smaller. Use with care.

performRequest :: Maybe [Status] -> Request -> ClientM Response

performWithStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a

TODO: support UVerb (acceptStatus argument, like in performRequest above).

data ClientEnv

The environment in which a request is run. The baseUrl and makeClientRequest function are used to create a http-client request. Cookies are then added to that request if a CookieJar is set on the environment. Finally the request is executed with the manager. The makeClientRequest function can be used to modify the request to execute and set values which are not specified on a servant Request like responseTimeout or redirectCount

Constructors

ClientEnv

Fields

• manager :: Manager
• baseUrl :: BaseUrl
• cookieJar :: Maybe (TVar CookieJar)
• makeClientRequest :: BaseUrl -> Request -> Request

  this function can be used to customize the creation of http-client requests from servant requests. Default value: defaultMakeClientRequest Note that: 1. makeClientRequest exists to allow overriding operational semantics e.g. responseTimeout per request, If you need global modifications, you should use managerModifyRequest 2. the cookieJar, if defined, is being applied after makeClientRequest is called.

Instances

MonadReader ClientEnv ClientM

Defined in Servant.Client.Internal.HttpClient

Methods

ask :: ClientM ClientEnv

local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a

reader :: (ClientEnv -> a) -> ClientM a

MonadReader ClientEnv ClientM

Defined in Servant.Client.Internal.HttpClient.Streaming

Methods

ask :: ClientM ClientEnv

local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a

reader :: (ClientEnv -> a) -> ClientM a

mkClientEnv :: Manager -> BaseUrl -> ClientEnv

ClientEnv smart constructor.

clientResponseToResponse :: (a -> b) -> Response a -> ResponseF b

defaultMakeClientRequest :: BaseUrl -> Request -> Request

Create a http-client Request from a servant Request The host, path and port fields are extracted from the BaseUrl otherwise the body, headers and query string are derived from the servant Request

catchConnectionError :: IO a -> IO (Either ClientError a)