Safe Haskell | None |
---|---|
Language | Haskell2010 |
Servant.Client.Core.Request
Contents
Synopsis
- type Request = RequestF RequestBody Builder
- data RequestF body path = Request {
- requestPath :: path
- requestQueryString :: Seq QueryItem
- requestBody :: Maybe (body, MediaType)
- requestAccept :: Seq MediaType
- requestHeaders :: Seq Header
- requestHttpVersion :: HttpVersion
- requestMethod :: Method
- data RequestBody
- = RequestBodyLBS ByteString
- | RequestBodyBS ByteString
- | RequestBodySource (SourceIO ByteString)
- defaultRequest :: Request
- addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request
- appendToPath :: Builder -> Request -> Request
- appendToQueryString :: Text -> Maybe ByteString -> Request -> Request
- encodeQueryParamValue :: ToHttpApiData a => a -> ByteString
- setQueryString :: Query -> Request -> Request
- setRequestBody :: RequestBody -> MediaType -> Request -> Request
- setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request
Documentation
type Request = RequestF RequestBody Builder Source #
data RequestF body path Source #
Constructors
Request | |
Fields
|
Instances
Bifoldable RequestF Source # | |||||
Bifunctor RequestF Source # | |||||
Bitraversable RequestF Source # | |||||
Defined in Servant.Client.Core.Request Methods bitraverse :: Applicative f => (a -> f c) -> (b -> f d) -> RequestF a b -> f (RequestF c d) | |||||
Functor (RequestF body) Source # | |||||
Foldable (RequestF body) Source # | |||||
Defined in Servant.Client.Core.Request Methods fold :: Monoid m => RequestF body m -> m foldMap :: Monoid m => (a -> m) -> RequestF body a -> m foldMap' :: Monoid m => (a -> m) -> RequestF body a -> m foldr :: (a -> b -> b) -> b -> RequestF body a -> b foldr' :: (a -> b -> b) -> b -> RequestF body a -> b foldl :: (b -> a -> b) -> b -> RequestF body a -> b foldl' :: (b -> a -> b) -> b -> RequestF body a -> b foldr1 :: (a -> a -> a) -> RequestF body a -> a foldl1 :: (a -> a -> a) -> RequestF body a -> a toList :: RequestF body a -> [a] null :: RequestF body a -> Bool length :: RequestF body a -> Int elem :: Eq a => a -> RequestF body a -> Bool maximum :: Ord a => RequestF body a -> a minimum :: Ord a => RequestF body a -> a | |||||
Traversable (RequestF body) Source # | |||||
Defined in Servant.Client.Core.Request | |||||
(NFData path, NFData body) => NFData (RequestF body path) Source # | |||||
Defined in Servant.Client.Core.Request | |||||
Generic (RequestF body path) Source # | |||||
Defined in Servant.Client.Core.Request Associated Types
| |||||
(Show a, Show b) => Show (RequestF a b) Source # | |||||
(Eq path, Eq body) => Eq (RequestF body path) Source # | |||||
type Rep (RequestF body path) Source # | |||||
Defined in Servant.Client.Core.Request type Rep (RequestF body path) = D1 ('MetaData "RequestF" "Servant.Client.Core.Request" "servant-client-core-0.20.2-J3IKD4axEWrF1VZnHtpE21" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 path) :*: (S1 ('MetaSel ('Just "requestQueryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq QueryItem)) :*: S1 ('MetaSel ('Just "requestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (body, MediaType))))) :*: ((S1 ('MetaSel ('Just "requestAccept") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq MediaType)) :*: S1 ('MetaSel ('Just "requestHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Header))) :*: (S1 ('MetaSel ('Just "requestHttpVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpVersion) :*: S1 ('MetaSel ('Just "requestMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Method))))) |
data RequestBody Source #
The request body. R replica of the http-client
RequestBody
.
Constructors
RequestBodyLBS ByteString | |
RequestBodyBS ByteString | |
RequestBodySource (SourceIO ByteString) |
Instances
Generic RequestBody Source # | |||||
Defined in Servant.Client.Core.Request Associated Types
| |||||
Show RequestBody Source # | |||||
Defined in Servant.Client.Core.Request Methods showsPrec :: Int -> RequestBody -> ShowS show :: RequestBody -> String showList :: [RequestBody] -> ShowS | |||||
type Rep RequestBody Source # | |||||
Defined in Servant.Client.Core.Request type Rep RequestBody = D1 ('MetaData "RequestBody" "Servant.Client.Core.Request" "servant-client-core-0.20.2-J3IKD4axEWrF1VZnHtpE21" 'False) (C1 ('MetaCons "RequestBodyLBS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: (C1 ('MetaCons "RequestBodyBS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "RequestBodySource" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (SourceIO ByteString))))) |
Modifiers
addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request Source #
Add header to the request being constructed.
appendToPath :: Builder -> Request -> Request Source #
Append extra path to the request being constructed.
Warning: This function assumes that the path fragment is already URL-encoded.
Append a query parameter to the request being constructed.
encodeQueryParamValue :: ToHttpApiData a => a -> ByteString Source #
Encode a query parameter value.
setQueryString :: Query -> Request -> Request Source #
setRequestBody :: RequestBody -> MediaType -> Request -> Request Source #
Set body and media type of the request being constructed.
Since: 0.12
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