Hreq.Core.Client.HasRequest

This module provides a HasRequest class that Interprets a ReqContent type level list into RequestF data

Documentation

pattern Empty :: Hlist '[]

class HasRequest (reqComponents :: k) (verb :: Type) where

HasRequest is used to create a Request from a ReqContent type level list and a Verb.

verb is requited for obtaining Request method and MediaType value

reqComponents is a usually a 'ReqContent Type' type level list. It can be something else.

Associated Types

type HttpInput reqComponents :: Type

Methods

httpReq :: Proxy verb -> Proxy reqComponents -> HttpInput reqComponents -> Request -> Request

Instances

(HttpReqConstraints ts, ReflectMethod method, SingI (Req ts), SingI (Res rs), HttpResConstraints rs) => HasRequest (ts :: [ReqContent Type]) (Verb method rs)

Defined in Hreq.Core.Client.HasRequest

Associated Types

type HttpInput ts :: Type

Methods

httpReq :: Proxy (Verb method rs) -> Proxy ts -> HttpInput ts -> Request -> Request

getAcceptHeader :: forall (rs :: [ResContent Type]). HttpResConstraints rs => Sing rs -> Maybe MediaType

encodeHlistAsReq :: forall (ts :: [ReqContent Type]). HttpReqConstraints ts => Sing ts -> Hlist (HttpReq ts) -> Request -> Request

Transform a Hlist of inputs into a RequestF

createParam :: (KnownSymbol p, ToHttpApiData a) => Sing p -> a -> QueryItem

appendQueryFlags :: [String] -> Request -> Request

toQueryFlags :: forall (fs :: [Symbol]). All KnownSymbol fs => Sing fs -> [String]