Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Routes.QualifiedCapture

Synopsis

type QualifiedCapture capture a = QualifiedCapture' '[] capture a
data QualifiedCapture' (mods :: [Type]) (capture :: Symbol) (a :: Type)
type WithDomain mods capture a api = Capture (AppendSymbol capture "_domain") Domain :> (Capture' mods capture a :> api)

Documentation

type QualifiedCapture capture a = QualifiedCapture' '[] capture a Source #

Capture a value qualified by a domain.

This works exactly like capturing a domain first then the value, but it provides a Qualified value to the handler, instead of both a domain and a value.

data QualifiedCapture' (mods :: [Type]) (capture :: Symbol) (a :: Type) Source #

Capture a value qualified by a domain, with modifiers.

Instances

Instances details

(RoutesToPaths api, KnownSymbol (AppendSymbol capture "_domain"), KnownSymbol capture) => RoutesToPaths (QualifiedCapture' mods capture a :> api :: Type) Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture Methods getRoutes :: Forest PathSegment Source #
(KnownSymbol capture, ToHttpApiData a, HasClient m api, KnownSymbol (AppendSymbol capture "_domain")) => HasClient m (QualifiedCapture' mods capture a :> api) Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture Associated Types type Client m (QualifiedCapture' mods capture a :> api) Source # Methods clientWithRoute :: Proxy m -> Proxy (QualifiedCapture' mods capture a :> api) -> Request -> Client m (QualifiedCapture' mods capture a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (QualifiedCapture' mods capture a :> api) -> (forall x. mon x -> mon' x) -> Client mon (QualifiedCapture' mods capture a :> api) -> Client mon' (QualifiedCapture' mods capture a :> api) Source #
(ToParamSchema a, HasOpenApi api, KnownSymbol capture, KnownSymbol (AppendSymbol capture "_domain"), KnownSymbol (FoldDescription mods)) => HasOpenApi (QualifiedCapture' mods capture a :> api :: Type) Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture Methods toOpenApi :: Proxy (QualifiedCapture' mods capture a :> api) -> OpenApi Source #
(KnownSymbol capture, Typeable a, FromHttpApiData a, HasServer api context, SBoolI (FoldLenient mods), KnownSymbol (AppendSymbol capture "_domain"), HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters) => HasServer (QualifiedCapture' mods capture a :> api :: Type) context Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture Associated Types type ServerT (QualifiedCapture' mods capture a :> api) m Source # Methods route :: Proxy (QualifiedCapture' mods capture a :> api) -> Context context -> Delayed env (Server (QualifiedCapture' mods capture a :> api)) -> Router env Source # hoistServerWithContext :: Proxy (QualifiedCapture' mods capture a :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (QualifiedCapture' mods capture a :> api) m -> ServerT (QualifiedCapture' mods capture a :> api) n Source #
type Client m (QualifiedCapture' mods capture a :> api) Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture type Client m (QualifiedCapture' mods capture a :> api) = Qualified a -> Client m api
type SpecialiseToVersion v (QualifiedCapture' mods capture a :> api) Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture type SpecialiseToVersion v (QualifiedCapture' mods capture a :> api) = QualifiedCapture' mods capture a :> SpecialiseToVersion v api
type ServerT (QualifiedCapture' mods capture a :> api :: Type) m Source #
Instance details Defined in Wire.API.Routes.QualifiedCapture type ServerT (QualifiedCapture' mods capture a :> api :: Type) m = Qualified (If (FoldLenient mods) (Either String a) a) -> ServerT api m

type WithDomain mods capture a api = Capture (AppendSymbol capture "_domain") Domain :> (Capture' mods capture a :> api) Source #