Servant.Util.Common.Common

Documentation

type family ApplicationLS x where ...

Equations

ApplicationLS (a b) = a

type family ApplicationRS x where ...

Extract right side of type application.

Equations

ApplicationRS (a b) = b

class ApiHasArgClass api where

Proves info about argument specifier of servant API.

Minimal complete definition

Nothing

Associated Types

type ApiArg api :: Type

For arguments-specifiers of API, get argument type. E.g. Capture "cap" Int -> Int.

type ApiArg api = ApplicationRS api

Methods

apiArgName :: Proxy api -> String

Name of argument. E.g. name of argument specified by Capture "nyan" is nyan.

default apiArgName :: forall n someApiType a. (KnownSymbol n, api ~ someApiType n a) => Proxy api -> String

Instances

KnownSymbol s => ApiHasArgClass (QueryFlag s)

Defined in Servant.Util.Common.Common

Associated Types

type ApiArg (QueryFlag s)

Methods

apiArgName :: Proxy (QueryFlag s) -> String

ApiHasArgClass (ReqBody ct a)

Defined in Servant.Util.Common.Common

Associated Types

type ApiArg (ReqBody ct a)

Methods

apiArgName :: Proxy (ReqBody ct a) -> String

KnownSymbol s => ApiHasArgClass (Capture s a)

Defined in Servant.Util.Common.Common

Associated Types

type ApiArg (Capture s a)

Methods

apiArgName :: Proxy (Capture s a) -> String

KnownSymbol s => ApiHasArgClass (QueryParam' mods s a)

Defined in Servant.Util.Common.Common

Associated Types

type ApiArg (QueryParam' mods s a)

Methods

apiArgName :: Proxy (QueryParam' mods s a) -> String

type ApiHasArg subApi res = (ApiHasArgClass subApi, ApiHasArgInvariant subApi res Handler)

inRouteServer :: forall api api' ctx env. (Proxy api -> Context ctx -> Delayed env (Server api) -> Router env) -> (Server api' -> Server api) -> Proxy api' -> Context ctx -> Delayed env (Server api') -> Router env

Modify handler in implementation of route.

symbolValT :: forall s. KnownSymbol s => Text

Similar to symbolVal, but shorter in use.

data NameLabel (name :: Symbol)

Helper for passing type-level symbol at term-level. We do not use Proxy for this because defining instance IsLabel name (Proxy name) in a library is not a really good idea.

Constructors

NameLabel

Instances

n1 ~ n2 => IsLabel n1 (NameLabel n2)

Defined in Servant.Util.Common.Common

Methods

fromLabel :: NameLabel n2