Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- mkReq :: (Request cfg request, SessionState st) => request -> SafeReqSt st cfg (Output request)
- runRequests :: StateT Session (SafeReqM cfg) a -> SafeReqM cfg a
- runStRequests :: st -> StateT st (SafeReqM cfg) a -> SafeReqM cfg a
- runReqM :: MonadIO m => SafeReqM () a -> m (Either SafeException a)
- runReqWithParamsM :: MonadIO m => [Option 'Https] -> SafeReqM () a -> m (Either SafeException a)
- runSessReqM :: MonadIO m => cfg -> SafeReqM cfg a -> m (Either SafeException a)
- runSessReqWithParamsM :: MonadIO m => [Option 'Https] -> cfg -> SafeReqM cfg a -> m (Either SafeException a)
- maybeQueryParam :: (Monoid param, QueryParam param, ToHttpApiData a) => Text -> Maybe a -> param
Documentation
mkReq :: (Request cfg request, SessionState st) => request -> SafeReqSt st cfg (Output request) Source #
Call a single request. See runRequest
and runStRequests
to build and execute a set of requests that share the
same state, session and configuration.
runRequests :: StateT Session (SafeReqM cfg) a -> SafeReqM cfg a Source #
Run a normal session based request state monad.
runStRequests :: st -> StateT st (SafeReqM cfg) a -> SafeReqM cfg a Source #
Run a user defined session request state monad.
runReqM :: MonadIO m => SafeReqM () a -> m (Either SafeException a) Source #
Prepare to run requests.
runReqWithParamsM :: MonadIO m => [Option 'Https] -> SafeReqM () a -> m (Either SafeException a) Source #
Prepare to run requests with addional header options.
runSessReqM :: MonadIO m => cfg -> SafeReqM cfg a -> m (Either SafeException a) Source #
Prepare to run request with config.
runSessReqWithParamsM :: MonadIO m => [Option 'Https] -> cfg -> SafeReqM cfg a -> m (Either SafeException a) Source #
Prepare to run request with config and additional header options.
maybeQueryParam :: (Monoid param, QueryParam param, ToHttpApiData a) => Text -> Maybe a -> param Source #
Create a request parameter only if the value is Just
. For Nothing
the parameter is not present at all in the request.