Servant.API.WithNamedContext

Synopsis

data WithNamedContext

Packageservant-0.20.3.0
Exports1
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWithNamedContext.hs

datadata WithNamedContext (name :: Symbol) (subContext :: [Type]) (subApi :: k)

Source#

WithNamedContext names a specific tagged context to use for the combinators in the API. (See also in servant-server, Servant.Server.Context.) For example:

type UseNamedContextAPI = WithNamedContext "myContext" '[String] (
    ReqBody '[JSON] Int :> Get '[JSON] Int)

Both the ReqBody and Get combinators will use the WithNamedContext with type tag "myContext" as their context.

Contexts are only relevant for servant-server.

For more information, see the tutorial.

Instances2HasLink, MkLink

HasLink sub => HasLink (WithNamedContext name context sub)Defined in servant-0.20.3.0 · Servant.Links
type MkLink (WithNamedContext name context sub) a = MkLink sub aDefined in servant-0.20.3.0 · Servant.Links