Safe Haskell	None
Language	Haskell2010

Servant.Client

Description

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

Synopsis

client :: HasClient ClientM api => Proxy api -> Client ClientM api
data ClientM a
runClientM :: ClientM a -> ClientEnv -> IO (Either ClientError a)
data ClientEnv = ClientEnv {
- manager :: Manager
- baseUrl :: BaseUrl
- cookieJar :: Maybe (TVar CookieJar)
}
mkClientEnv :: Manager -> BaseUrl -> ClientEnv
hoistClient :: HasClient ClientM api => Proxy api -> (forall a. m a -> n a) -> Client m api -> Client n api
module Servant.Client.Core.Reexport

Documentation

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

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 Source #

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

Instances

Monad ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods (>>=) :: ClientM a -> (a -> ClientM b) -> ClientM b # (>>) :: ClientM a -> ClientM b -> ClientM b # return :: a -> ClientM a # fail :: String -> ClientM a #
Functor ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods fmap :: (a -> b) -> ClientM a -> ClientM b # (<$) :: a -> ClientM b -> ClientM a #
Applicative ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient 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 Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods liftIO :: IO a -> ClientM a #
MonadThrow ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods throwM :: Exception e => e -> ClientM a #
MonadCatch ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods catch :: Exception e => ClientM a -> (e -> ClientM a) -> ClientM a #
Alt ClientM Source #	Try clients in order, last error is preserved.
Instance details Defined in Servant.Client.Internal.HttpClient Methods (<!>) :: ClientM a -> ClientM a -> ClientM a # some :: Applicative ClientM => ClientM a -> ClientM [a] # many :: Applicative ClientM => ClientM a -> ClientM [a] #
RunClient ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods runRequest :: Request -> ClientM Response # throwClientError :: ClientError -> ClientM a #
MonadReader ClientEnv ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods ask :: ClientM ClientEnv # local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a # reader :: (ClientEnv -> a) -> ClientM a #
MonadBase IO ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods liftBase :: IO α -> ClientM α #
MonadBaseControl IO ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Associated Types type StM ClientM a :: Type # Methods liftBaseWith :: (RunInBase ClientM IO -> IO a) -> ClientM a # restoreM :: StM ClientM a -> ClientM a #
MonadError ClientError ClientM Source #
Instance details Defined in Servant.Client.Internal.HttpClient Methods throwError :: ClientError -> ClientM a # catchError :: ClientM a -> (ClientError -> ClientM a) -> ClientM a #
Generic (ClientM a) Source #
Instance details Defined in Servant.Client.Internal.HttpClient Associated Types type Rep (ClientM a) :: Type -> Type # Methods from :: ClientM a -> Rep (ClientM a) x # to :: Rep (ClientM a) x -> ClientM a #
type StM ClientM a Source #
Instance details Defined in Servant.Client.Internal.HttpClient type StM ClientM a = Either ClientError a
type Rep (ClientM a) Source #
Instance details Defined in Servant.Client.Internal.HttpClient type Rep (ClientM a) = D1 (MetaData "ClientM" "Servant.Client.Internal.HttpClient" "servant-client-0.16.0.1-BK1ECVfY37dAKrB6rrx5rd" True) (C1 (MetaCons "ClientM" PrefixI True) (S1 (MetaSel (Just "unClientM") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ReaderT ClientEnv (ExceptT ClientError IO) a))))

runClientM :: ClientM a -> ClientEnv -> IO (Either ClientError a) Source #

data ClientEnv Source #

The environment in which a request is run.

Constructors

ClientEnv
Fields manager :: Manager baseUrl :: BaseUrl cookieJar :: Maybe (TVar CookieJar)

Instances

MonadReader ClientEnv ClientM Source #
Instance details 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 Source #
Instance details 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 Source #

ClientEnv smart constructor.

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

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