Moduleservant-client-core-0.20.3.0Haskell2010

Servant.Client.Core.Request

3 types
8 values

Packageservant-client-core-0.20.3.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRequest.hs

typetype Request = RequestF RequestBody Builder

datadata RequestF body path

Constructors

Request
- requestPath :: path
- requestQueryString :: Seq QueryItem
- requestBody :: Maybe (body, MediaType)
- requestAccept :: Seq MediaType
- requestHeaders :: Seq Header
- requestHttpVersion :: HttpVersion
- requestMethod :: Method

Instances11Bifoldable, Bifunctor, Bitraversable, Functor, Foldable, Traversable, …

Bifoldable RequestFDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Bifunctor RequestFDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Bitraversable RequestFDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Functor (RequestF body)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Foldable (RequestF body)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Traversable (RequestF body)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
(Eq path, Eq body) => Eq (RequestF body path)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
(Show a, Show b) => Show (RequestF a b)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Generic (RequestF body path)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
(NFData path, NFData body) => NFData (RequestF body path)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
type Rep (RequestF body path) = D1 ('MetaData "RequestF" "Servant.Client.Core.Request" "servant-client-core-0.20.3.0-9talVRwUAeqjSfLFEex5M" '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)))))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request

datadata RequestBody

The request body. R replica of the http-client RequestBody.

Constructors

Instances3Show, Generic, Rep

Show RequestBodyDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
Generic RequestBodyDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request
type Rep RequestBody = D1 ('MetaData "RequestBody" "Servant.Client.Core.Request" "servant-client-core-0.20.3.0-9talVRwUAeqjSfLFEex5M" 'False) (C1 ('MetaCons "RequestBodyLBS" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: (C1 ('MetaCons "RequestBodyBS" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "RequestBodySource" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (SourceIO ByteString)))))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.Request

valuedefaultRequest :: Request

Modifiers

7 declarations

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

Add header to the request being constructed.

valueappendToPath :: Builder -> Request -> Request

Append extra path to the request being constructed.

Warning: This function assumes that the path fragment is already URL-encoded.

valueappendToQueryString

:: Text
query param name
-> Maybe ByteString
query param value
-> Request
-> Request

Append a query parameter to the request being constructed.

valueencodeQueryParamValue :: ToHttpApiData a => a -> ByteString

Encode a query parameter value.

valuesetQueryString :: Query -> Request -> Request

valuesetRequestBody :: RequestBody -> MediaType -> Request -> Request

Set body and media type of the request being constructed.

valuesetRequestBodyLBS :: 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.