Servant.Client.Core.Internal.Request

Documentation

data ServantError

A type representing possible errors in a request

Note that this type substantially changed in 0.12.

Constructors

FailureResponse Response

The server returned an error response

DecodeFailure Text Response

The body could not be decoded at the expected type

UnsupportedContentType MediaType Response

The content-type of the response is not supported

InvalidContentTypeHeader Response

The content-type header is invalid

ConnectionError Text

There was a connection error, and no response was received

Instances

Eq ServantError

Methods

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

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

Show ServantError

Methods

showsPrec :: Int -> ServantError -> ShowS

show :: ServantError -> String

showList :: [ServantError] -> ShowS

Generic ServantError

Associated Types

type Rep ServantError :: * -> *

Methods

from :: ServantError -> Rep ServantError x

to :: Rep ServantError x -> ServantError

Exception ServantError

Methods

toException :: ServantError -> SomeException

fromException :: SomeException -> Maybe ServantError

displayException :: ServantError -> String

type Rep ServantError

type Rep ServantError = D1 * (MetaData "ServantError" "Servant.Client.Core.Internal.Request" "servant-client-core-0.13-DCvzKzA1mBvGLqBbRwhkUX" False) ((:+:) * ((:+:) * (C1 * (MetaCons "FailureResponse" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Response))) (C1 * (MetaCons "DecodeFailure" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Response))))) ((:+:) * (C1 * (MetaCons "UnsupportedContentType" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * MediaType)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Response)))) ((:+:) * (C1 * (MetaCons "InvalidContentTypeHeader" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Response))) (C1 * (MetaCons "ConnectionError" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))))))

data RequestF a

Constructors

Request

Fields

• requestPath :: a
• requestQueryString :: Seq QueryItem
• requestBody :: Maybe (RequestBody, MediaType)
• requestAccept :: Seq MediaType
• requestHeaders :: Seq Header
• requestHttpVersion :: HttpVersion
• requestMethod :: Method

Instances

Functor RequestF

Methods

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

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

Eq a => Eq (RequestF a)

Methods

(==) :: RequestF a -> RequestF a -> Bool

(/=) :: RequestF a -> RequestF a -> Bool

Show a => Show (RequestF a)

Methods

showsPrec :: Int -> RequestF a -> ShowS

show :: RequestF a -> String

showList :: [RequestF a] -> ShowS

Generic (RequestF a)

Associated Types

type Rep (RequestF a) :: * -> *

Methods

from :: RequestF a -> Rep (RequestF a) x

to :: Rep (RequestF a) x -> RequestF a

type Rep (RequestF a)

type Rep (RequestF a) = D1 * (MetaData "RequestF" "Servant.Client.Core.Internal.Request" "servant-client-core-0.13-DCvzKzA1mBvGLqBbRwhkUX" False) (C1 * (MetaCons "Request" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "requestPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a)) ((:*:) * (S1 * (MetaSel (Just Symbol "requestQueryString") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Seq QueryItem))) (S1 * (MetaSel (Just Symbol "requestBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe (RequestBody, MediaType)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "requestAccept") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Seq MediaType))) (S1 * (MetaSel (Just Symbol "requestHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Seq Header)))) ((:*:) * (S1 * (MetaSel (Just Symbol "requestHttpVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * HttpVersion)) (S1 * (MetaSel (Just Symbol "requestMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Method))))))

type Request = RequestF Builder

newtype RequestBody

The request body. Currently only lazy ByteStrings are supported.

Constructors

RequestBodyLBS ByteString

Instances

Eq RequestBody

Methods

(==) :: RequestBody -> RequestBody -> Bool

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

Ord RequestBody

Methods

compare :: RequestBody -> RequestBody -> Ordering

(<) :: RequestBody -> RequestBody -> Bool

(<=) :: RequestBody -> RequestBody -> Bool

(>) :: RequestBody -> RequestBody -> Bool

(>=) :: RequestBody -> RequestBody -> Bool

max :: RequestBody -> RequestBody -> RequestBody

min :: RequestBody -> RequestBody -> RequestBody

Read RequestBody

Methods

readsPrec :: Int -> ReadS RequestBody

readList :: ReadS [RequestBody]

readPrec :: ReadPrec RequestBody

readListPrec :: ReadPrec [RequestBody]

Show RequestBody

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

data GenResponse a

Constructors

Response

Fields

• responseStatusCode :: Status
• responseHeaders :: Seq Header
• responseHttpVersion :: HttpVersion
• responseBody :: a

Instances

Functor GenResponse

Methods

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

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

Foldable GenResponse

Methods

fold :: Monoid m => GenResponse m -> m

foldMap :: Monoid m => (a -> m) -> GenResponse a -> m

foldr :: (a -> b -> b) -> b -> GenResponse a -> b

foldr' :: (a -> b -> b) -> b -> GenResponse a -> b

foldl :: (b -> a -> b) -> b -> GenResponse a -> b

foldl' :: (b -> a -> b) -> b -> GenResponse a -> b

foldr1 :: (a -> a -> a) -> GenResponse a -> a

foldl1 :: (a -> a -> a) -> GenResponse a -> a

toList :: GenResponse a -> [a]

null :: GenResponse a -> Bool

length :: GenResponse a -> Int

elem :: Eq a => a -> GenResponse a -> Bool

maximum :: Ord a => GenResponse a -> a

minimum :: Ord a => GenResponse a -> a

sum :: Num a => GenResponse a -> a

product :: Num a => GenResponse a -> a

Traversable GenResponse

Methods

traverse :: Applicative f => (a -> f b) -> GenResponse a -> f (GenResponse b)

sequenceA :: Applicative f => GenResponse (f a) -> f (GenResponse a)

mapM :: Monad m => (a -> m b) -> GenResponse a -> m (GenResponse b)

sequence :: Monad m => GenResponse (m a) -> m (GenResponse a)

Eq a => Eq (GenResponse a)

Methods

(==) :: GenResponse a -> GenResponse a -> Bool

(/=) :: GenResponse a -> GenResponse a -> Bool

Show a => Show (GenResponse a)

Methods

showsPrec :: Int -> GenResponse a -> ShowS

show :: GenResponse a -> String

showList :: [GenResponse a] -> ShowS

Generic (GenResponse a)

Associated Types

type Rep (GenResponse a) :: * -> *

Methods

from :: GenResponse a -> Rep (GenResponse a) x

to :: Rep (GenResponse a) x -> GenResponse a

type Rep (GenResponse a)

type Rep (GenResponse a) = D1 * (MetaData "GenResponse" "Servant.Client.Core.Internal.Request" "servant-client-core-0.13-DCvzKzA1mBvGLqBbRwhkUX" False) (C1 * (MetaCons "Response" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "responseStatusCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Status)) (S1 * (MetaSel (Just Symbol "responseHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Seq Header)))) ((:*:) * (S1 * (MetaSel (Just Symbol "responseHttpVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * HttpVersion)) (S1 * (MetaSel (Just Symbol "responseBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a)))))

type Response = GenResponse ByteString

newtype StreamingResponse

Constructors

StreamingResponse

Fields

• runStreamingResponse :: forall a. (GenResponse (IO ByteString) -> IO a) -> IO a

defaultRequest :: Request

appendToPath :: Text -> Request -> Request

appendToQueryString

Arguments

:: Text

param name

-> Maybe Text

param value

-> Request

-> Request

addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request

setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request

Set body and media type of the request being constructed.

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

Since: 0.12

setRequestBody :: RequestBody -> MediaType -> Request -> Request

Set body and media type of the request being constructed.

Since: 0.12