Servant.API.WithNamedContext

Documentation

data WithNamedContext (name :: Symbol) (subContext :: [Type]) subApi

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.

Instances

HasLink sub => HasLink (WithNamedContext name context sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (WithNamedContext name context sub) a

Methods

toLink :: (Link -> a) -> Proxy (WithNamedContext name context sub) -> Link -> MkLink (WithNamedContext name context sub) a

type MkLink (WithNamedContext name context sub :: Type) a

Defined in Servant.Links

type MkLink (WithNamedContext name context sub :: Type) a = MkLink sub a