Hercules.API.Servant

Extras for working with servant

Documentation

noContent :: Functor m => m NoContent -> m ()

void specialised to NoContent to soothe the compiler that rightfully warns about throwing away a do notation result. By specialising, we make sure that we still get warnings if the result type changes in the future. (We'll get an error)

Generic

useApi :: forall subapi api mode. GenericServant subapi mode => (api mode -> ToServant subapi mode) -> api mode -> subapi mode

Postcomposes fromServant to an accessor, preserving the mode parameter, because otherwise the mode parameter can not be inferred.

Ideally, this functionality would be built into a new combinator.

useApiE :: forall subapi api mode a. GenericServant (subapi a) mode => (api a mode -> ToServant (subapi a) mode) -> api a mode -> subapi a mode

Like useApi but constrains the auth type variable that's passed to subapis.

enterApi :: forall subapi api mode. GenericServant subapi mode => api mode -> (api mode -> ToServant subapi mode) -> subapi mode

@flip useApi

enterApiE :: forall subapi api mode a. GenericServant (subapi a) mode => api a mode -> (api a mode -> ToServant (subapi a) mode) -> subapi a mode

@flip useApiE

Substitution

type family Substitute (target :: k) subapi :: Type

Replaces Placeholder by subapi in the API target.

Instances

type Substitute Placeholder subapi

Defined in Hercules.API.Servant

type Substitute Placeholder subapi = subapi

type Substitute (a :<|> b :: Type) subapi

Defined in Hercules.API.Servant

type Substitute (a :<|> b :: Type) subapi = Substitute a subapi :<|> Substitute b subapi

type Substitute (a :> b :: Type) subapi

Defined in Hercules.API.Servant

type Substitute (a :> b :: Type) subapi = a :> Substitute b subapi

data Placeholder

A reference to the subapi parameter in Substitute

Instances

type Substitute Placeholder subapi

Defined in Hercules.API.Servant

type Substitute Placeholder subapi = subapi