Hreq.Core.API.TypeLevel

Type level functions over ReqContent and ResContent

Documentation

type family ApiToReq (a :: api) :: [ReqContent Type] where ...

ApiToReq transforms an API type into a type level list of Request component content types. The resulting list is used by the HasRequest class.

Equations

ApiToReq (Verb m ts) = '[]

ApiToReq ((path :: Symbol) :> ts) = Path () path ': ApiToReq ts

ApiToReq ((x :: ReqContent Type) :> ts) = x ': ApiToReq ts

type family GetVerb (a :: api) :: Type where ...

Given an API type, GetVerb retrieves the Verb type component which is used by the HasResponse class.

Equations

GetVerb (Verb m ts) = Verb m ts

GetVerb (api :> sub) = GetVerb sub

type family HttpReq (ts :: [ReqContent Type]) :: [Type] where ...

HttpReq interprets a ReqContent list as a Type level list used in the HasRequest class for representing request component inputs

Equations

HttpReq '[] = '[]

HttpReq (Path _ _ ': ts) = HttpReq ts

HttpReq (ReqBody ctyp a ': ts) = a ': HttpReq ts

HttpReq (StreamBody ctyp a ': ts) = a ': HttpReq ts

HttpReq (BasicAuth _ _ ': ts) = BasicAuthData ': HttpReq ts

HttpReq (QueryFlags _ _ ': ts) = HttpReq ts

HttpReq (Params ('(s, a) ': ps) ': ts) = a ': HttpReq (Params ps ': ts)

HttpReq (Params '[] ': ts) = HttpReq ts

HttpReq (CaptureAll a ': ts) = [a] ': HttpReq ts

HttpReq (Captures (a ': cs) ': ts) = a ': HttpReq (Captures cs ': ts)

HttpReq (Captures '[] ': ts) = HttpReq ts

HttpReq (ReqHeaders ('(s, a) ': hs) ': ts) = a ': HttpReq (ReqHeaders hs ': ts)

HttpReq (ReqHeaders '[] ': ts) = HttpReq ts

type family HttpRes (res :: [ResContent Type]) :: [Type] where ...

HttpRes interprets a ResContent list as a Type level list for used HasResponse class to represent responses

Equations

HttpRes '[] = '[]

HttpRes (ResBody ctyp a ': ts) = a ': HttpRes ts

HttpRes (ResHeaders (s ': hs) ': ts) = [Header] ': HttpRes ts

HttpRes (ResHeaders '[] ': ts) = HttpRes ts

HttpRes (Raw a ': ts) = HttpRes ts

type family HttpResConstraints (res :: [ResContent Type]) :: Constraint where ...

Response content types Constraints.

Equations

HttpResConstraints '[] = ()

HttpResConstraints (ResBody ctyp a ': ts) = (HasMediaType ctyp, MediaDecode ctyp a, HttpResConstraints ts)

HttpResConstraints (ResStream ctyp a ': ts) = (HasMediaType ctyp, HttpResConstraints ts)

HttpResConstraints (ResHeaders hs ': ts) = (HttpSymbolTypePair hs, HttpResConstraints ts)

HttpResConstraints (Raw a ': ts) = HttpResConstraints ts

type family HttpReqConstraints (req :: [ReqContent Type]) :: Constraint where ...

Request content types Constraints.

Equations

HttpReqConstraints '[] = ()

HttpReqConstraints (Path _ path ': ts) = (KnownSymbol path, HttpReqConstraints ts)

HttpReqConstraints (BasicAuth _ _ ': ts) = HttpReqConstraints ts

HttpReqConstraints (ReqBody ctyp a ': ts) = (HasMediaType ctyp, MediaEncode ctyp a, HttpReqConstraints ts)

HttpReqConstraints (StreamBody ctyp a ': ts) = (HasMediaType ctyp, HasStreamBody a, HttpReqConstraints ts)

HttpReqConstraints (QueryFlags _a fs ': ts) = (All KnownSymbol fs, HttpReqConstraints ts)

HttpReqConstraints (Params ('(s, a) ': ps) ': ts) = (KnownSymbol s, ToHttpApiData a, HttpReqConstraints (Params ps ': ts))

HttpReqConstraints (Params '[] ': ts) = HttpReqConstraints ts

HttpReqConstraints (Captures (a ': cs) ': ts) = (ToHttpApiData a, HttpReqConstraints (Captures cs ': ts))

HttpReqConstraints (Captures '[] ': ts) = HttpReqConstraints ts

HttpReqConstraints (CaptureAll a ': ts) = (ToHttpApiData a, HttpReqConstraints ts)

HttpReqConstraints (ReqHeaders ('(s, a) ': hs) ': ts) = (KnownSymbol s, ToHttpApiData a, HttpReqConstraints (ReqHeaders hs ': ts))

HttpReqConstraints (ReqHeaders '[] ': ts) = HttpReqConstraints ts

type family HttpSymbolTypePair (ts :: [(Symbol, Type)]) :: Constraint where ...

For a given HTTP API data Symbol Type tuple list generate Constraints for all the members.

Equations

HttpSymbolTypePair ts = (All KnownSymbol (AllFsts ts), All ToHttpApiData (AllSnds ts))

type family UniqMembers (ts :: [k]) (label :: Symbol) :: Constraint where ...

Cross check that there are no repeated instance of an item with in a type level list. For instance we want to have only one ResBody with in a Response type level list

Equations

UniqMembers '[] label = ()

UniqMembers (a ': ts) label = (UniqMember a ts label, UniqMembers ts label)

type family UniqMember (a :: k) (ts :: [k]) (label :: Symbol) :: Constraint where ...

Equations

UniqMember a '[] label = ()

UniqMember a (a ': ts) label = TypeError ((((Text "Type " :<>: ShowType a) :<>: Text "Should be unique with in the ") :<>: Text label) :<>: Text " type level list")

UniqMember a (b ': ts) label = UniqMember b ts label

type family All (a :: k -> Constraint) (ts :: [k]) :: Constraint where ...

Equations

All c '[] = ()

All c (t ': ts) = (c t, All c ts)

type family AllFsts (a :: [(k1, k2)]) :: [k1] where ...

Equations

AllFsts '[] = '[]

AllFsts ('(f, s) ': ts) = f ': AllFsts ts

type family AllSnds (a :: [(k1, k2)]) :: [k2] where ...

Equations

AllSnds '[] = '[]

AllSnds ('(f, s) ': ts) = s ': AllSnds ts