Copyright	(c) Frederick Pringle 2025
License	BSD-3-Clause
Maintainer	freddyjepringle@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Servant.API.Routes.Internal.Response

Description

Internal module, subject to change.

Synopsis

newtype Responses = Responses {
- _unResponses :: Some Response
}
unResponses :: Lens' Responses (Some Response)
data Response = Response {
- _responseType :: TypeRep
- _responseHeaders :: Set HeaderRep
}
responseType :: Lens' Response TypeRep
responseHeaders :: Lens' Response (Set HeaderRep)
class HasResponse a where
- getResponse :: Response
class AllHasResponse (as :: [Type]) where
- getResponses :: [Response]

Documentation

newtype Responses Source #

A representation of the response(s) that a Servant endpoint can return.

Under the hood, Responses is a Some Response. This allows for the possibility that an endpoint might return one of several responses, via UVerb.

Note that a Response consists of a return body type, as well as the return headers.

Constructors

Responses
Fields _unResponses :: Some Response

Instances

Instances details

ToJSON Responses Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods toJSON :: Responses -> Value Source # toEncoding :: Responses -> Encoding Source # toJSONList :: [Responses] -> Value Source # toEncodingList :: [Responses] -> Encoding Source #
Monoid Responses Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods mempty :: Responses Source # mappend :: Responses -> Responses -> Responses Source # mconcat :: [Responses] -> Responses Source #
Semigroup Responses Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods (<>) :: Responses -> Responses -> Responses Source # sconcat :: NonEmpty Responses -> Responses Source # stimes :: Integral b => b -> Responses -> Responses Source #
Show Responses Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods showsPrec :: Int -> Responses -> ShowS Source # show :: Responses -> String Source # showList :: [Responses] -> ShowS Source #
Eq Responses Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods (==) :: Responses -> Responses -> Bool Source # (/=) :: Responses -> Responses -> Bool Source #

unResponses :: Lens' Responses (Some Response) Source #

data Response Source #

A representation of one possible response that a Servant endpoint can return.

Currently, the only situation in which multiple Responses can be returned is using the UVerb combinator. This bundles response types together with response Headers, so we do the same here.

Constructors

Response
Fields _responseType :: TypeRep _responseHeaders :: Set HeaderRep

Instances

Instances details

ToJSON Response Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods toJSON :: Response -> Value Source # toEncoding :: Response -> Encoding Source # toJSONList :: [Response] -> Value Source # toEncodingList :: [Response] -> Encoding Source #
Show Response Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods showsPrec :: Int -> Response -> ShowS Source # show :: Response -> String Source # showList :: [Response] -> ShowS Source #
Eq Response Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods (==) :: Response -> Response -> Bool Source # (/=) :: Response -> Response -> Bool Source #
Ord Response Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods compare :: Response -> Response -> Ordering Source # (<) :: Response -> Response -> Bool Source # (<=) :: Response -> Response -> Bool Source # (>) :: Response -> Response -> Bool Source # (>=) :: Response -> Response -> Bool Source # max :: Response -> Response -> Response Source # min :: Response -> Response -> Response Source #

responseType :: Lens' Response TypeRep Source #

responseHeaders :: Lens' Response (Set HeaderRep) Source #

class HasResponse a where Source #

Get a term-level response from a type-level argument. This encodes the argument(s) of a Verb or UVerb.

Similar to Typeable, but also get the response Headers.

Methods

getResponse :: Response Source #

Instances

Instances details

Typeable a => HasResponse a Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods getResponse :: Response Source #
(HasResponse a, GetHeaderReps hs) => HasResponse (Headers hs a) Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods getResponse :: Response Source #

class AllHasResponse (as :: [Type]) where Source #

Witness that all members of a type-level list are instances of HasResponse.

This class does 2 things:

It lets us get a term-level list of Responses from a type-level list of types, all of which have HasResponse instances.
More impressively, its instances enforce that getResponses will only type-check for type-level lists of length 2 or more. This is because AllHasResponse will only ever be used by oneOfResponses, which is the only way to construct a Many @Response and thus lets us enforce the invariant that its list arguments will always have more than 1 element. This lets us make sure that there's only ever one way to represent a list of Responses using Responses.

Of course, someone might import this Internal module and define a HasResponse a => AllHasResponse '[a] instance. Don't do that.

Methods

getResponses :: [Response] Source #

Instances

Instances details

(HasResponse a, AllHasResponse (b ': (c ': as))) => AllHasResponse (a ': (b ': (c ': as))) Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods getResponses :: [Response] Source #
(HasResponse a, HasResponse b) => AllHasResponse '[a, b] Source #
Instance details Defined in Servant.API.Routes.Internal.Response Methods getResponses :: [Response] Source #