Servant.Common.Req

Documentation

data ServantError

Constructors

FailureResponse

Fields

• 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

Methods

(==) :: ServantError -> ServantError -> Bool

(/=) :: ServantError -> ServantError -> Bool

Show ServantError

Methods

showsPrec :: Int -> ServantError -> ShowS

show :: ServantError -> String

showList :: [ServantError] -> ShowS

Exception ServantError

Methods

toException :: ServantError -> SomeException

fromException :: SomeException -> Maybe ServantError

displayException :: ServantError -> String

MonadError ServantError ClientM

Methods

throwError :: ServantError -> ClientM a

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

data Req

Constructors

Req

Fields

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

defReq :: Req

appendToPath :: String -> Req -> Req

appendToQueryString

Arguments

:: Text

param name

-> Maybe Text

param value

-> Req

-> Req

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

setRQBody :: ByteString -> MediaType -> Req -> Req

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

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

Set body and media type of the request being constructed.

Since: 0.9.2.0

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

performing requests

displayHttpRequest :: Method -> String

data ClientEnv

Constructors

ClientEnv

Fields

• manager :: Manager
• baseUrl :: BaseUrl

Instances

MonadReader ClientEnv ClientM

Methods

ask :: ClientM ClientEnv

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

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

newtype ClientM a

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

Methods

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

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

return :: a -> ClientM a

fail :: String -> ClientM a

Functor ClientM

Methods

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

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

Applicative ClientM

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

Methods

liftIO :: IO a -> ClientM a

MonadThrow ClientM

Methods

throwM :: Exception e => e -> ClientM a

MonadCatch ClientM

Methods

catch :: Exception e => ClientM a -> (e -> ClientM a) -> ClientM a

Alt ClientM

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

Methods

liftBase :: IO α -> ClientM α

MonadBaseControl IO ClientM

Associated Types

type StM (ClientM :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase ClientM IO -> IO a) -> ClientM a

restoreM :: StM ClientM a -> ClientM a

MonadError ServantError ClientM

Methods

throwError :: ServantError -> ClientM a

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

MonadReader ClientEnv ClientM

Methods

ask :: ClientM ClientEnv

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

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

Generic (ClientM a)

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)

Methods

mkClient :: ClientM a -> ClientM a

type StM ClientM a

type StM ClientM a = Either ServantError a

type Rep (ClientM a)

type Rep (ClientM a) = D1 (MetaData "ClientM" "Servant.Common.Req" "servant-client-0.10-5hSWIFWz0Ou26EqOFBVxb2" 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)

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

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

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

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