Hreq.Core.API.Request

Specification for valid Request component types used at the Kind and Type level for creating an API structure.

Request Type

data ReqContent a

Constructors

Path a Symbol

Params [(Symbol, a)]

QueryFlags a [Symbol]

Captures [a]

BasicAuth a Symbol

CaptureAll a

ReqBody a a

StreamBody a a

ReqHeaders [(Symbol, a)]

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

SingI ts => SingI (Params ts :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (Params ts)

SingI ts => SingI (Captures ts :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (Captures ts)

SingI a => SingI (CaptureAll a :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (CaptureAll a)

SingI a => SingI (ReqHeaders a :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (ReqHeaders a)

(SingI a, SingI s) => SingI (Path a s :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (Path a s)

(SingI a, SingI ts) => SingI (QueryFlags a ts :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (QueryFlags a ts)

(SingI a, SingI s) => SingI (BasicAuth a s :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (BasicAuth a s)

(SingI a, SingI ctyp) => SingI (ReqBody ctyp a :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (ReqBody ctyp a)

(SingI a, SingI ctyp) => SingI (StreamBody ctyp a :: ReqContent Type)

Defined in Hreq.Core.API.Request

Methods

sing :: Sing (StreamBody ctyp a)

type Sing

Defined in Hreq.Core.API.Request

type Sing = SReqContent

type HttpInput (ts :: [ReqContent Type])

Defined in Hreq.Core.Client.HasRequest

type HttpInput (ts :: [ReqContent Type]) = Hlist (HttpReq ts)

Request Type Synonyms

type Captures = Captures

type QueryFlags = QueryFlags ()

type Params = Params

type ReqBody = ReqBody

type StreamBody = StreamBody

type ReqHeaders = ReqHeaders

type CaptureAll = CaptureAll

type BasicAuth = BasicAuth ()

type Path = Path ()

type QueryFlag (s :: Symbol) = QueryFlags '[s]

type Param s t = Params '['(s, t)]

type Capture t = Captures '[t]

Request as a Singleton GADT

data SReqContent (a :: ReqContent Type)

Constructors

a ~ Path t s => SPath (Sing t) (Sing s)

a ~ QueryFlags b ts => SQueryFlags (Sing b) (Sing ts)

a ~ CaptureAll b => SCaptureAll (Sing b)

a ~ Captures ts => SCaptures (Sing ts)

a ~ ReqBody ctyp b => SReqBody (Sing ctyp) (Sing b)

a ~ StreamBody ctyp b => SStreamBody (Sing ctyp) (Sing b)

a ~ ReqHeaders ts => SReqHeaders (Sing ts)

a ~ Params ts => SParams (Sing ts)

a ~ BasicAuth b s => SBasicAuth (Sing b) (Sing s)