servant-http-streams-0.18: Automatic derivation of querying functions for servant

Safe HaskellNone
LanguageHaskell2010

Servant.HttpStreams.Internal

Synopsis

Documentation

data ClientEnv Source #

The environment in which a request is run.

ClientEnv carries an open connection. See withClientEnvIO.

Constructors

ClientEnv 
Instances
MonadReader ClientEnv ClientM Source # 
Instance details

Defined in Servant.HttpStreams.Internal

Methods

ask :: ClientM ClientEnv #

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

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

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

Open a connection to BaseUrl.

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

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

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

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

Methods

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

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

Applicative ClientM Source # 
Instance details

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

Defined in Servant.HttpStreams.Internal

Methods

liftIO :: IO a -> ClientM a #

Alt ClientM Source #

Try clients in order, last error is preserved.

Instance details

Defined in Servant.HttpStreams.Internal

RunClient ClientM Source # 
Instance details

Defined in Servant.HttpStreams.Internal

RunStreamingClient ClientM Source # 
Instance details

Defined in Servant.HttpStreams.Internal

MonadReader ClientEnv ClientM Source # 
Instance details

Defined in Servant.HttpStreams.Internal

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

Methods

liftBase :: IO α -> ClientM α #

MonadError ClientError ClientM Source # 
Instance details

Defined in Servant.HttpStreams.Internal

Generic (ClientM a) Source # 
Instance details

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) Source # 
Instance details

Defined in Servant.HttpStreams.Internal

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