Servant.HttpStreams

This module provides client which can automatically generate querying functions for each endpoint just from the type representing your API.

Documentation

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

data ClientM a

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

Instances

Monad ClientM

Defined in Servant.HttpStreams.Internal

Methods

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

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

return :: a -> ClientM a

Functor ClientM

Defined in Servant.HttpStreams.Internal

Methods

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

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

Applicative ClientM

Defined in Servant.HttpStreams.Internal

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.HttpStreams.Internal

Methods

liftIO :: IO a -> ClientM a

Alt ClientM

Try clients in order, last error is preserved.

Defined in Servant.HttpStreams.Internal

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.HttpStreams.Internal

Methods

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

throwClientError :: ClientError -> ClientM a

RunStreamingClient ClientM

Defined in Servant.HttpStreams.Internal

Methods

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

MonadReader ClientEnv ClientM

Defined in Servant.HttpStreams.Internal

Methods

ask :: ClientM ClientEnv

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

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

MonadBase IO ClientM

Defined in Servant.HttpStreams.Internal

Methods

liftBase :: IO α -> ClientM α

MonadError ClientError ClientM

Defined in Servant.HttpStreams.Internal

Methods

throwError :: ClientError -> ClientM a

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

Generic (ClientM a)

Defined in Servant.HttpStreams.Internal

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.HttpStreams.Internal

type Rep (ClientM a) = D1 ('MetaData "ClientM" "Servant.HttpStreams.Internal" "servant-http-streams-0.18.4-AzajkAp7OMqIzEwa30Fthi" 'True) (C1 ('MetaCons "ClientM" 'PrefixI 'True) (S1 ('MetaSel ('Just "unClientM") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReaderT ClientEnv (ExceptT ClientError (Codensity IO)) a))))

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

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

data ClientEnv

The environment in which a request is run.

ClientEnv carries an open connection. See withClientEnvIO.

Constructors

ClientEnv

Fields

• baseUrl :: BaseUrl
• connection :: Connection

Instances

MonadReader ClientEnv ClientM

Defined in Servant.HttpStreams.Internal

Methods

ask :: ClientM ClientEnv

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

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

mkClientEnv :: BaseUrl -> Connection -> ClientEnv

ClientEnv smart constructor.

withClientEnvIO :: BaseUrl -> (ClientEnv -> IO r) -> IO r

Open a connection to BaseUrl.

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

module Servant.Client.Core.Reexport