Safe Haskell | None |
---|---|
Language | Haskell2010 |
Servant.Client.Core.Internal.Request
Synopsis
- data ServantError
- = FailureResponse Response
- | DecodeFailure Text Response
- | UnsupportedContentType MediaType Response
- | InvalidContentTypeHeader Response
- | ConnectionError Text
- data RequestF a = Request {
- requestPath :: a
- requestQueryString :: Seq QueryItem
- requestBody :: Maybe (RequestBody, MediaType)
- requestAccept :: Seq MediaType
- requestHeaders :: Seq Header
- requestHttpVersion :: HttpVersion
- requestMethod :: Method
- type Request = RequestF Builder
- data RequestBody
- = RequestBodyLBS ByteString
- | RequestBodyBS ByteString
- | RequestBodyBuilder Int64 Builder
- | RequestBodyStream Int64 ((IO ByteString -> IO ()) -> IO ())
- | RequestBodyStreamChunked ((IO ByteString -> IO ()) -> IO ())
- | RequestBodyIO (IO RequestBody)
- data GenResponse a = Response {
- responseStatusCode :: Status
- responseHeaders :: Seq Header
- responseHttpVersion :: HttpVersion
- responseBody :: a
- type Response = GenResponse ByteString
- type StreamingResponse = GenResponse (IO ByteString)
- defaultRequest :: Request
- appendToPath :: Text -> Request -> Request
- appendToQueryString :: Text -> Maybe Text -> Request -> Request
- addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request
- setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request
- setRequestBody :: RequestBody -> MediaType -> Request -> Request
Documentation
data ServantError Source #
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 Source # | |
Defined in Servant.Client.Core.Internal.Request | |
Show ServantError Source # | |
Defined in Servant.Client.Core.Internal.Request Methods showsPrec :: Int -> ServantError -> ShowS show :: ServantError -> String showList :: [ServantError] -> ShowS | |
Generic ServantError Source # | |
Defined in Servant.Client.Core.Internal.Request Associated Types type Rep ServantError :: Type -> Type | |
Exception ServantError Source # | |
Defined in Servant.Client.Core.Internal.Request Methods toException :: ServantError -> SomeException fromException :: SomeException -> Maybe ServantError displayException :: ServantError -> String | |
NFData ServantError Source # | |
Defined in Servant.Client.Core.Internal.Request Methods rnf :: ServantError -> () | |
type Rep ServantError Source # | |
Defined in Servant.Client.Core.Internal.Request type Rep ServantError = D1 (MetaData "ServantError" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-t44wFjzkdz2dxByKLhjGp" False) ((C1 (MetaCons "FailureResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: C1 (MetaCons "DecodeFailure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response))) :+: (C1 (MetaCons "UnsupportedContentType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MediaType) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: (C1 (MetaCons "InvalidContentTypeHeader" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: C1 (MetaCons "ConnectionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))) |
Constructors
Request | |
Fields
|
Instances
Generic (RequestF a) Source # | |
type Rep (RequestF a) Source # | |
Defined in Servant.Client.Core.Internal.Request type Rep (RequestF a) = D1 (MetaData "RequestF" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-t44wFjzkdz2dxByKLhjGp" False) (C1 (MetaCons "Request" PrefixI True) ((S1 (MetaSel (Just "requestPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: (S1 (MetaSel (Just "requestQueryString") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq QueryItem)) :*: S1 (MetaSel (Just "requestBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (RequestBody, MediaType))))) :*: ((S1 (MetaSel (Just "requestAccept") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq MediaType)) :*: S1 (MetaSel (Just "requestHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq Header))) :*: (S1 (MetaSel (Just "requestHttpVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HttpVersion) :*: S1 (MetaSel (Just "requestMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Method))))) |
data RequestBody Source #
The request body. A replica of the http-client
RequestBody
.
Constructors
RequestBodyLBS ByteString | |
RequestBodyBS ByteString | |
RequestBodyBuilder Int64 Builder | |
RequestBodyStream Int64 ((IO ByteString -> IO ()) -> IO ()) | |
RequestBodyStreamChunked ((IO ByteString -> IO ()) -> IO ()) | |
RequestBodyIO (IO RequestBody) |
Instances
Generic RequestBody Source # | |
Defined in Servant.Client.Core.Internal.Request Associated Types type Rep RequestBody :: Type -> Type | |
type Rep RequestBody Source # | |
Defined in Servant.Client.Core.Internal.Request type Rep RequestBody = D1 (MetaData "RequestBody" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-t44wFjzkdz2dxByKLhjGp" False) ((C1 (MetaCons "RequestBodyLBS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) :+: (C1 (MetaCons "RequestBodyBS" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) :+: C1 (MetaCons "RequestBodyBuilder" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Builder)))) :+: (C1 (MetaCons "RequestBodyStream" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ((IO ByteString -> IO ()) -> IO ()))) :+: (C1 (MetaCons "RequestBodyStreamChunked" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ((IO ByteString -> IO ()) -> IO ()))) :+: C1 (MetaCons "RequestBodyIO" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (IO RequestBody)))))) |
data GenResponse a Source #
Constructors
Response | |
Fields
|
Instances
Functor GenResponse Source # | |
Defined in Servant.Client.Core.Internal.Request Methods fmap :: (a -> b) -> GenResponse a -> GenResponse b (<$) :: a -> GenResponse b -> GenResponse a | |
Foldable GenResponse Source # | |
Defined in Servant.Client.Core.Internal.Request 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 Source # | |
Defined in Servant.Client.Core.Internal.Request 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) Source # | |
Defined in Servant.Client.Core.Internal.Request | |
Show a => Show (GenResponse a) Source # | |
Defined in Servant.Client.Core.Internal.Request Methods showsPrec :: Int -> GenResponse a -> ShowS show :: GenResponse a -> String showList :: [GenResponse a] -> ShowS | |
Generic (GenResponse a) Source # | |
Defined in Servant.Client.Core.Internal.Request Associated Types type Rep (GenResponse a) :: Type -> Type | |
NFData a => NFData (GenResponse a) Source # | |
Defined in Servant.Client.Core.Internal.Request Methods rnf :: GenResponse a -> () | |
type Rep (GenResponse a) Source # | |
Defined in Servant.Client.Core.Internal.Request type Rep (GenResponse a) = D1 (MetaData "GenResponse" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-t44wFjzkdz2dxByKLhjGp" False) (C1 (MetaCons "Response" PrefixI True) ((S1 (MetaSel (Just "responseStatusCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Status) :*: S1 (MetaSel (Just "responseHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq Header))) :*: (S1 (MetaSel (Just "responseHttpVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HttpVersion) :*: S1 (MetaSel (Just "responseBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))) |
type Response = GenResponse ByteString Source #
type StreamingResponse = GenResponse (IO ByteString) Source #
appendToPath :: Text -> Request -> Request Source #
setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request 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.12
setRequestBody :: RequestBody -> MediaType -> Request -> Request Source #
Set body and media type of the request being constructed.
Since: 0.12