Hreq.Core.Client.HasResponse

This module provides a HasResponse class that Interprets Verb content into a particular api endpoint query result.

For instance Verb GET '[] gets interpreted as an empty response of type Unit i.e ()

Documentation

class MonadError ClientError m => HasResponse (a :: k) m where

Associated Types

type HttpOutput a :: Type

Methods

httpRes :: sing a -> Response -> m (HttpOutput a)

Instances

MonadError ClientError m => HasResponse ([] :: [k]) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput [] :: Type

Methods

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

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 ': []))

(UniqMembers rs "Response", HasResponse rs m) => HasResponse (Verb method rs :: Type) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (Verb method rs) :: Type

Methods

httpRes :: sing (Verb method rs) -> Response -> m (HttpOutput (Verb method rs))

decodeAsBody :: forall ctyp a m sing. (MonadError ClientError m, MediaDecode ctyp a) => sing ctyp -> Response -> m a

decodeAsHlist :: (MonadError ClientError m, HttpResConstraints rs) => Sing rs -> Response -> m (Hlist (HttpRes rs))

Turn a Response into a Hlist of outputs