Hreq.Core.API.Response

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

Response type

data ResContent a

Constructors

ResBody a a

ResHeaders [(Symbol, a)]

ResStream a a

ResStatus a Nat

Raw 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 (ResHeaders ts :: ResContent Type)

Defined in Hreq.Core.API.Response

Methods

sing :: Sing (ResHeaders ts)

SingI a => SingI (Raw a :: ResContent Type)

Defined in Hreq.Core.API.Response

Methods

sing :: Sing (Raw a)

(SingI ctyp, SingI a) => SingI (ResBody ctyp a :: ResContent Type)

Defined in Hreq.Core.API.Response

Methods

sing :: Sing (ResBody ctyp a)

(SingI a, SingI ctyp) => SingI (ResStream ctyp a :: ResContent Type)

Defined in Hreq.Core.API.Response

Methods

sing :: Sing (ResStream ctyp a)

(SingI a, SingI n) => SingI (ResStatus a n :: ResContent Type)

Defined in Hreq.Core.API.Response

Methods

sing :: Sing (ResStatus a n)

MonadError ClientError m => HasResponse ((ResStream :: a -> a -> ResContent a) ': rs :: [a -> a -> ResContent a]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResStream ': rs) :: Type

Methods

httpRes :: sing (ResStream ': rs) -> Response -> m (HttpOutput (ResStream ': rs))

(MonadError ClientError m, SingI (Res (ResHeaders hs ': rs)), HttpResConstraints (ResHeaders hs ': rs)) => HasResponse (ResHeaders hs ': rs :: [ResContent Type]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResHeaders hs ': rs) :: Type

Methods

httpRes :: sing (ResHeaders hs ': rs) -> Response -> m (HttpOutput (ResHeaders hs ': rs))

(MonadError ClientError m, KnownNat n, SingI (Res (r ': rs)), HttpResConstraints (r ': rs)) => HasResponse (ResStatus n ': (r ': rs) :: [ResContent Type]) m

Expected status code much match received code in a response code list

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResStatus n ': (r ': rs)) :: Type

Methods

httpRes :: sing (ResStatus n ': (r ': rs)) -> Response -> m (HttpOutput (ResStatus n ': (r ': rs)))

(MonadError ClientError m, KnownNat n) => HasResponse (ResStatus n ': ([] :: [ResContent Type]) :: [ResContent Type]) m

Expected status code much match received code

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResStatus n ': []) :: Type

Methods

httpRes :: sing (ResStatus n ': []) -> Response -> m (HttpOutput (ResStatus n ': []))

(MediaDecode ctyp a, MonadError ClientError m, SingI (Res (r ': rs)), HttpResConstraints (r ': rs)) => HasResponse (ResBody ctyp a ': (r ': rs) :: [ResContent Type]) m

The following type instance is overly restrictive to avoid overlapping type family instance error.

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResBody ctyp a ': (r ': rs)) :: Type

Methods

httpRes :: sing (ResBody ctyp a ': (r ': rs)) -> Response -> m (HttpOutput (ResBody ctyp a ': (r ': rs)))

(MediaDecode ctyp a, MonadError ClientError m) => HasResponse (ResBody ctyp a ': ([] :: [ResContent Type]) :: [ResContent Type]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (ResBody ctyp a ': []) :: Type

Methods

httpRes :: sing (ResBody ctyp a ': []) -> Response -> m (HttpOutput (ResBody ctyp a ': []))

MonadError ClientError m => HasResponse (Raw a2 ': (r ': rs) :: [ResContent a1]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (Raw a2 ': (r ': rs)) :: Type

Methods

httpRes :: sing (Raw a2 ': (r ': rs)) -> Response -> m (HttpOutput (Raw a2 ': (r ': rs)))

MonadError ClientError m => HasResponse (Raw a2 ': ([] :: [ResContent a1]) :: [ResContent a1]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (Raw a2 ': []) :: Type

Methods

httpRes :: sing (Raw a2 ': []) -> Response -> m (HttpOutput (Raw a2 ': []))

type Sing

Defined in Hreq.Core.API.Response

type Sing = SResContent

type HttpOutput ((ResStream :: a -> a -> ResContent a) ': rs :: [a -> a -> ResContent a])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput ((ResStream :: a -> a -> ResContent a) ': rs :: [a -> a -> ResContent a]) = (TypeError (Text "ResStream shouldn't be an instance of HasResponse class") :: Type)

type HttpOutput (ResHeaders hs ': rs :: [ResContent Type])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (ResHeaders hs ': rs :: [ResContent Type]) = Hlist (HttpRes (ResHeaders hs ': rs))

type HttpOutput (ResStatus n ': (r ': rs) :: [ResContent Type])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (ResStatus n ': (r ': rs) :: [ResContent Type]) = Hlist (HttpRes (r ': rs))

type HttpOutput (ResStatus n ': ([] :: [ResContent Type]) :: [ResContent Type])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (ResStatus n ': ([] :: [ResContent Type]) :: [ResContent Type]) = Response

type HttpOutput (ResBody ctyp a ': (r ': rs) :: [ResContent Type])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (ResBody ctyp a ': (r ': rs) :: [ResContent Type]) = Hlist (a ': HttpRes (r ': rs))

type HttpOutput (ResBody ctyp a ': ([] :: [ResContent Type]) :: [ResContent Type])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (ResBody ctyp a ': ([] :: [ResContent Type]) :: [ResContent Type]) = a

type HttpOutput (Raw a2 ': (r ': rs) :: [ResContent a1])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (Raw a2 ': (r ': rs) :: [ResContent a1]) = (TypeError (Text "Raw should be used only in a singleton list") :: Type)

type HttpOutput (Raw a2 ': ([] :: [ResContent a1]) :: [ResContent a1])

Defined in Hreq.Core.Client.HasResponse

type HttpOutput (Raw a2 ': ([] :: [ResContent a1]) :: [ResContent a1]) = Response

Response type synonyms

type ResBody = ResBody

type ResHeaders = ResHeaders

type ResStream = ResStream

type Raw = Raw ()

type ResStatus = ResStatus ()

Response as a Singleton GADT

data SResContent (a :: ResContent Type) where

Constructors

SResBody :: forall ctyp a. Sing ctyp -> Sing a -> SResContent (ResBody ctyp a)

SResStream :: forall ctyp a. Sing ctyp -> Sing a -> SResContent (ResStream ctyp a)

SResHeaders :: forall (ts :: [(Symbol, Type)]). Sing ts -> SResContent (ResHeaders ts)

SResStatus :: forall (a :: Type) (n :: Nat). Sing a -> Sing n -> SResContent (ResStatus a n)

SRaw :: forall (a :: Type). Sing a -> SResContent (Raw a)