Safe Haskell	None
Language	Haskell2010

Servant.Generic

Contents

Internals

Synopsis

Documentation

type family mode :- api infixl 3 Source #

A type family that applies an appropriate type family to the api parameter. For example, passing AsApi will leave api untouched, while AsServerT m will produce ServerT api m.

Instances

type AsLink :- api Source #
type AsLink :- api = MkLink * api
type AsApi :- api Source #
type AsApi :- api = api
type (AsServerT m) :- api Source #
type (AsServerT m) :- api = ServerT * api m

data AsServerT m Source #

A type that specifies that an API record contains a server implementation.

Instances

type (AsServerT m) :- api Source #
type (AsServerT m) :- api = ServerT * api m

type AsServer = AsServerT Handler Source #

data AsApi Source #

A type that specifies that an API record contains an API definition. Only useful at type-level.

Instances

type AsApi :- api Source #
type AsApi :- api = api

data AsLink Source #

A type that specifies that an API record contains a set of links.

(Useful since servant 0.12)

Instances

type AsLink :- api Source #
type AsLink :- api = MkLink * api

type ToServant a = GToServant (Rep a) Source #

Turns a generic product type into a linear tree of :<|> combinators. For example, given

  data Foo route = Foo
    { foo :: route :-
        Get '[PlainText] Text
    , bar :: route :-
        Get '[PlainText] Text
    }

 ToServant (Foo AsApi) ~ Get '[PlainText] Text :<|> Get '[PlainText] Text

toServant :: GenericProduct a => a -> ToServant a Source #

See ToServant, but at value-level.

fromServant :: GenericProduct a => ToServant a -> a Source #

Inverse of toServant.

This can be used to turn generated values such as client functions into records.

You may need to provide a type signature for the output type (your record type).

type GenericProduct a = (Generic a, GProduct (Rep a)) Source #

Internals

class GProduct f where Source #

A class of generic product types.

Minimal complete definition

gtoServant, gfromServant

Associated Types

type GToServant f Source #

Methods

gtoServant :: f p -> GToServant f Source #

gfromServant :: GToServant f -> f p Source #

Instances

GProduct (K1 i c) Source #
Associated Types type GToServant (K1 i c :: * -> ) :: Source # Methods gtoServant :: K1 i c p -> GToServant (K1 i c) Source # gfromServant :: GToServant (K1 i c) -> K1 i c p Source #
(GProduct l, GProduct r) => GProduct ((:*:) l r) Source #
Associated Types type GToServant ((::) l r :: -> ) :: Source # Methods gtoServant :: (l :: r) p -> GToServant (l :: r) Source # gfromServant :: GToServant (l :: r) -> (l :: r) p Source #
GProduct f => GProduct (M1 i c f) Source #
Associated Types type GToServant (M1 i c f :: * -> ) :: Source # Methods gtoServant :: M1 i c f p -> GToServant (M1 i c f) Source # gfromServant :: GToServant (M1 i c f) -> M1 i c f p Source #

class Generic a where #

Representable types of kind *. This class is derivable in GHC with the DeriveGeneric flag on.

Minimal complete definition

from, to

Associated Types

type Rep a :: * -> * #

Generic representation type

Methods

from :: a -> Rep a x #

Convert from the datatype to its representation

to :: Rep a x -> a #

Convert from the representation to the datatype

Instances

Generic Bool
Associated Types type Rep Bool :: * -> * # Methods from :: Bool -> Rep Bool x # to :: Rep Bool x -> Bool #
Generic Ordering
Associated Types type Rep Ordering :: * -> * # Methods from :: Ordering -> Rep Ordering x # to :: Rep Ordering x -> Ordering #
Generic ()
Associated Types type Rep () :: * -> * # Methods from :: () -> Rep () x # to :: Rep () x -> () #
Generic Version
Associated Types type Rep Version :: * -> * # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Generic Fixity
Associated Types type Rep Fixity :: * -> * # Methods from :: Fixity -> Rep Fixity x # to :: Rep Fixity x -> Fixity #
Generic Associativity
Associated Types type Rep Associativity :: * -> * # Methods from :: Associativity -> Rep Associativity x # to :: Rep Associativity x -> Associativity #
Generic SourceUnpackedness
Associated Types type Rep SourceUnpackedness :: * -> * # Methods from :: SourceUnpackedness -> Rep SourceUnpackedness x # to :: Rep SourceUnpackedness x -> SourceUnpackedness #
Generic SourceStrictness
Associated Types type Rep SourceStrictness :: * -> * # Methods from :: SourceStrictness -> Rep SourceStrictness x # to :: Rep SourceStrictness x -> SourceStrictness #
Generic DecidedStrictness
Associated Types type Rep DecidedStrictness :: * -> * # Methods from :: DecidedStrictness -> Rep DecidedStrictness x # to :: Rep DecidedStrictness x -> DecidedStrictness #
Generic IsSecure
Associated Types type Rep IsSecure :: * -> * # Methods from :: IsSecure -> Rep IsSecure x # to :: Rep IsSecure x -> IsSecure #
Generic [a]
Associated Types type Rep [a] :: * -> * # Methods from :: [a] -> Rep [a] x # to :: Rep [a] x -> [a] #
Generic (Maybe a)
Associated Types type Rep (Maybe a) :: * -> * # Methods from :: Maybe a -> Rep (Maybe a) x # to :: Rep (Maybe a) x -> Maybe a #
Generic (V1 p)
Associated Types type Rep (V1 p) :: * -> * # Methods from :: V1 p -> Rep (V1 p) x # to :: Rep (V1 p) x -> V1 p #
Generic (U1 p)
Associated Types type Rep (U1 p) :: * -> * # Methods from :: U1 p -> Rep (U1 p) x # to :: Rep (U1 p) x -> U1 p #
Generic (Par1 p)
Associated Types type Rep (Par1 p) :: * -> * # Methods from :: Par1 p -> Rep (Par1 p) x # to :: Rep (Par1 p) x -> Par1 p #
Generic (Identity a)
Associated Types type Rep (Identity a) :: * -> * # Methods from :: Identity a -> Rep (Identity a) x # to :: Rep (Identity a) x -> Identity a #
Generic (Complex a)
Associated Types type Rep (Complex a) :: * -> * # Methods from :: Complex a -> Rep (Complex a) x # to :: Rep (Complex a) x -> Complex a #
Generic (Handler a)
Associated Types type Rep (Handler a) :: * -> * # Methods from :: Handler a -> Rep (Handler a) x # to :: Rep (Handler a) x -> Handler a #
Generic (Either a b)
Associated Types type Rep (Either a b) :: * -> * # Methods from :: Either a b -> Rep (Either a b) x # to :: Rep (Either a b) x -> Either a b #
Generic (Rec1 f p)
Associated Types type Rep (Rec1 f p) :: * -> * # Methods from :: Rec1 f p -> Rep (Rec1 f p) x # to :: Rep (Rec1 f p) x -> Rec1 f p #
Generic (URec Char p)
Associated Types type Rep (URec Char p) :: * -> * # Methods from :: URec Char p -> Rep (URec Char p) x # to :: Rep (URec Char p) x -> URec Char p #
Generic (URec Double p)
Associated Types type Rep (URec Double p) :: * -> * # Methods from :: URec Double p -> Rep (URec Double p) x # to :: Rep (URec Double p) x -> URec Double p #
Generic (URec Float p)
Associated Types type Rep (URec Float p) :: * -> * # Methods from :: URec Float p -> Rep (URec Float p) x # to :: Rep (URec Float p) x -> URec Float p #
Generic (URec Int p)
Associated Types type Rep (URec Int p) :: * -> * # Methods from :: URec Int p -> Rep (URec Int p) x # to :: Rep (URec Int p) x -> URec Int p #
Generic (URec Word p)
Associated Types type Rep (URec Word p) :: * -> * # Methods from :: URec Word p -> Rep (URec Word p) x # to :: Rep (URec Word p) x -> URec Word p #
Generic (URec (Ptr ()) p)
Associated Types type Rep (URec (Ptr ()) p) :: * -> * # Methods from :: URec (Ptr ()) p -> Rep (URec (Ptr ()) p) x # to :: Rep (URec (Ptr ()) p) x -> URec (Ptr ()) p #
Generic (a, b)
Associated Types type Rep (a, b) :: * -> * # Methods from :: (a, b) -> Rep (a, b) x # to :: Rep (a, b) x -> (a, b) #
Generic (Proxy k t)
Associated Types type Rep (Proxy k t) :: * -> * # Methods from :: Proxy k t -> Rep (Proxy k t) x # to :: Rep (Proxy k t) x -> Proxy k t #
Generic (K1 i c p)
Associated Types type Rep (K1 i c p) :: * -> * # Methods from :: K1 i c p -> Rep (K1 i c p) x # to :: Rep (K1 i c p) x -> K1 i c p #
Generic ((:+:) f g p)
Associated Types type Rep ((:+:) f g p) :: * -> * # Methods from :: (f :+: g) p -> Rep ((f :+: g) p) x # to :: Rep ((f :+: g) p) x -> (f :+: g) p #
Generic ((:*:) f g p)
Associated Types type Rep ((::) f g p) :: -> * # Methods from :: (f :: g) p -> Rep ((f :: g) p) x # to :: Rep ((f :: g) p) x -> (f :: g) p #
Generic ((:.:) f g p)
Associated Types type Rep ((:.:) f g p) :: * -> * # Methods from :: (f :.: g) p -> Rep ((f :.: g) p) x # to :: Rep ((f :.: g) p) x -> (f :.: g) p #
Generic (a, b, c)
Associated Types type Rep (a, b, c) :: * -> * # Methods from :: (a, b, c) -> Rep (a, b, c) x # to :: Rep (a, b, c) x -> (a, b, c) #
Generic (Tagged k s b)
Associated Types type Rep (Tagged k s b) :: * -> * # Methods from :: Tagged k s b -> Rep (Tagged k s b) x # to :: Rep (Tagged k s b) x -> Tagged k s b #
Generic (M1 i c f p)
Associated Types type Rep (M1 i c f p) :: * -> * # Methods from :: M1 i c f p -> Rep (M1 i c f p) x # to :: Rep (M1 i c f p) x -> M1 i c f p #
Generic (a, b, c, d)
Associated Types type Rep (a, b, c, d) :: * -> * # Methods from :: (a, b, c, d) -> Rep (a, b, c, d) x # to :: Rep (a, b, c, d) x -> (a, b, c, d) #
Generic (a, b, c, d, e)
Associated Types type Rep (a, b, c, d, e) :: * -> * # Methods from :: (a, b, c, d, e) -> Rep (a, b, c, d, e) x # to :: Rep (a, b, c, d, e) x -> (a, b, c, d, e) #
Generic (a, b, c, d, e, f)
Associated Types type Rep (a, b, c, d, e, f) :: * -> * # Methods from :: (a, b, c, d, e, f) -> Rep (a, b, c, d, e, f) x # to :: Rep (a, b, c, d, e, f) x -> (a, b, c, d, e, f) #
Generic (Verb k k1 method statusCode contentTypes a)
Associated Types type Rep (Verb k k1 method statusCode contentTypes a) :: * -> * # Methods from :: Verb k k1 method statusCode contentTypes a -> Rep (Verb k k1 method statusCode contentTypes a) x # to :: Rep (Verb k k1 method statusCode contentTypes a) x -> Verb k k1 method statusCode contentTypes a #
Generic (a, b, c, d, e, f, g)
Associated Types type Rep (a, b, c, d, e, f, g) :: * -> * # Methods from :: (a, b, c, d, e, f, g) -> Rep (a, b, c, d, e, f, g) x # to :: Rep (a, b, c, d, e, f, g) x -> (a, b, c, d, e, f, g) #

fieldLink :: forall routes endpoint. (IsElem endpoint (ToServant (routes AsApi)), HasLink endpoint) => (routes AsApi -> endpoint) -> MkLink endpoint Source #

Given an API record field, create a link for that route. Only the field's type is used.