Safe Haskell	None
Language	Haskell2010

Servant.Common.Req

Contents

performing requests

Synopsis

Documentation

data ServantError Source #

Constructors

FailureResponse
Fields failingRequest :: UrlReq responseStatus :: Status responseContentType :: MediaType responseBody :: ByteString
DecodeFailure
Fields decodeError :: String responseContentType :: MediaType responseBody :: ByteString
UnsupportedContentType
Fields responseContentType :: MediaType responseBody :: ByteString
InvalidContentTypeHeader
Fields responseContentTypeHeader :: ByteString responseBody :: ByteString
ConnectionError
Fields connectionError :: SomeException

Instances

Eq ServantError Source #
Methods (==) :: ServantError -> ServantError -> Bool # (/=) :: ServantError -> ServantError -> Bool #
Show ServantError Source #
Methods showsPrec :: Int -> ServantError -> ShowS # show :: ServantError -> String # showList :: [ServantError] -> ShowS #
Exception ServantError Source #
Methods toException :: ServantError -> SomeException # fromException :: SomeException -> Maybe ServantError # displayException :: ServantError -> String #
MonadError ServantError ClientM Source #
Methods throwError :: ServantError -> ClientM a # catchError :: ClientM a -> (ServantError -> ClientM a) -> ClientM a #

data UrlReq Source #

Constructors

UrlReq BaseUrl Req

Instances

Show UrlReq Source #
Methods showsPrec :: Int -> UrlReq -> ShowS # show :: UrlReq -> String # showList :: [UrlReq] -> ShowS #

data Req Source #

Constructors

Req
Fields reqPath :: Builder qs :: QueryText reqBody :: Maybe (RequestBody, MediaType) reqAccept :: [MediaType] headers :: [(String, Text)]

defReq :: Req Source #

appendToPath :: String -> Req -> Req Source #

appendToQueryString Source #

Arguments

:: Text	param name
-> Maybe Text	param value
-> Req
-> Req

addHeader :: ToHttpApiData a => String -> a -> Req -> Req Source #

setRQBody :: ByteString -> MediaType -> Req -> Req Source #

Deprecated: Use setReqBodyLBS instead

Set body and media type of the request being constructed.

The body is set to the given bytestring using the RequestBodyLBS constructor.

setReqBodyLBS :: ByteString -> MediaType -> Req -> Req Source #

Set body and media type of the request being constructed.

The body is set to the given bytestring using the RequestBodyLBS constructor.

Since: 0.9.2.0

setReqBody :: RequestBody -> MediaType -> Req -> Req Source #

Set body and media type of the request being constructed.

Since: 0.9.2.0

reqToRequest :: (Functor m, MonadThrow m) => Req -> BaseUrl -> m Request Source #

performing requests

displayHttpRequest :: Method -> String Source #

data ClientEnv Source #

Constructors

ClientEnv
Fields manager :: Manager baseUrl :: BaseUrl

Instances

MonadReader ClientEnv ClientM Source #
Methods ask :: ClientM ClientEnv # local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a # reader :: (ClientEnv -> a) -> ClientM a #

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.

Constructors

ClientM
Fields runClientM' :: ReaderT ClientEnv (ExceptT ServantError IO) a

Instances

Monad ClientM Source #
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 #
Methods fmap :: (a -> b) -> ClientM a -> ClientM b # (<$) :: a -> ClientM b -> ClientM a #
Applicative ClientM Source #
Methods pure :: a -> ClientM a # (<>) :: ClientM (a -> b) -> ClientM a -> ClientM b # (>) :: ClientM a -> ClientM b -> ClientM b # (<*) :: ClientM a -> ClientM b -> ClientM a #
MonadIO ClientM Source #
Methods liftIO :: IO a -> ClientM a #
MonadThrow ClientM Source #
Methods throwM :: Exception e => e -> ClientM a #
MonadCatch ClientM Source #
Methods catch :: Exception e => ClientM a -> (e -> ClientM a) -> ClientM a #
Alt ClientM Source #	Try clients in order, last error is preserved.
Methods (<!>) :: ClientM a -> ClientM a -> ClientM a # some :: Applicative ClientM => ClientM a -> ClientM [a] # many :: Applicative ClientM => ClientM a -> ClientM [a] #
MonadBase IO ClientM Source #
Methods liftBase :: IO α -> ClientM α #
MonadBaseControl IO ClientM Source #
Associated Types type StM (ClientM :: * -> ) a :: # Methods liftBaseWith :: (RunInBase ClientM IO -> IO a) -> ClientM a # restoreM :: StM ClientM a -> ClientM a #
MonadError ServantError ClientM Source #
Methods throwError :: ServantError -> ClientM a # catchError :: ClientM a -> (ServantError -> ClientM a) -> ClientM a #
MonadReader ClientEnv ClientM Source #
Methods ask :: ClientM ClientEnv # local :: (ClientEnv -> ClientEnv) -> ClientM a -> ClientM a # reader :: (ClientEnv -> a) -> ClientM a #
Generic (ClientM a) Source #
Associated Types type Rep (ClientM a) :: * -> * # Methods from :: ClientM a -> Rep (ClientM a) x # to :: Rep (ClientM a) x -> ClientM a #
ClientLike (ClientM a) (ClientM a) Source #
Methods mkClient :: ClientM a -> ClientM a Source #
type StM ClientM a Source #
type StM ClientM a = Either ServantError a
type Rep (ClientM a) Source #
type Rep (ClientM a) = D1 (MetaData "ClientM" "Servant.Common.Req" "servant-client-0.11-4RSSiFzwajNJXShte9KmtC" True) (C1 (MetaCons "ClientM" PrefixI True) (S1 (MetaSel (Just Symbol "runClientM'") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ReaderT * ClientEnv (ExceptT ServantError IO) a))))

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

performRequest :: Method -> Req -> ClientM (Int, ByteString, MediaType, [Header], Response ByteString) Source #

performRequestCT :: MimeUnrender ct result => Proxy ct -> Method -> Req -> ClientM ([Header], result) Source #

performRequestNoBody :: Method -> Req -> ClientM [Header] Source #

catchConnectionError :: IO a -> IO (Either ServantError a) Source #