Safe Haskell	None
Language	Haskell2010

Servant.Generic

Contents

Internals

Synopsis

type family mode :- api
data AsServerT (m :: * -> *)
type AsServer = AsServerT Handler
data AsApi
data AsLink
type ToServant a = GToServant (Rep a)
toServant :: GenericProduct a => a -> ToServant a
fromServant :: GenericProduct a => ToServant a -> a
type GenericProduct a = (Generic a, GProduct (Rep a))
class GProduct f where
- type GToServant f
class Generic a where
- type Rep a :: * -> *
fieldLink :: forall routes endpoint. (IsElem endpoint (ToServant (routes AsApi)), HasLink endpoint) => (routes AsApi -> endpoint) -> MkLink endpoint Link

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 #
Instance details Defined in Servant.Generic type AsLink :- api = MkLink api Link
type AsApi :- api Source #
Instance details Defined in Servant.Generic type AsApi :- api = api
type (AsServerT m) :- api Source #
Instance details Defined in Servant.Generic 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 #
Instance details Defined in Servant.Generic 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 #
Instance details Defined in Servant.Generic 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 #
Instance details Defined in Servant.Generic type AsLink :- api = MkLink api Link

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 #
Instance details Defined in Servant.Generic 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 #
Instance details Defined in Servant.Generic 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 #
Instance details Defined in Servant.Generic 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.

A Generic instance must satisfy the following laws:

from . to ≡ id
to . from ≡ id

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
Instance details Defined in GHC.Generics Associated Types type Rep Bool :: * -> * # Methods from :: Bool -> Rep Bool x # to :: Rep Bool x -> Bool #
Generic Ordering
Instance details Defined in GHC.Generics Associated Types type Rep Ordering :: * -> * # Methods from :: Ordering -> Rep Ordering x # to :: Rep Ordering x -> Ordering #
Generic ()
Instance details Defined in GHC.Generics Associated Types type Rep () :: * -> * # Methods from :: () -> Rep () x # to :: Rep () x -> () #
Generic ExitCode
Instance details Defined in GHC.IO.Exception Associated Types type Rep ExitCode :: * -> * # Methods from :: ExitCode -> Rep ExitCode x # to :: Rep ExitCode x -> ExitCode #
Generic Fixity
Instance details Defined in GHC.Generics Associated Types type Rep Fixity :: * -> * # Methods from :: Fixity -> Rep Fixity x # to :: Rep Fixity x -> Fixity #
Generic Associativity
Instance details Defined in GHC.Generics Associated Types type Rep Associativity :: * -> * # Methods from :: Associativity -> Rep Associativity x # to :: Rep Associativity x -> Associativity #
Generic SourceUnpackedness
Instance details Defined in GHC.Generics Associated Types type Rep SourceUnpackedness :: * -> * # Methods from :: SourceUnpackedness -> Rep SourceUnpackedness x # to :: Rep SourceUnpackedness x -> SourceUnpackedness #
Generic SourceStrictness
Instance details Defined in GHC.Generics Associated Types type Rep SourceStrictness :: * -> * # Methods from :: SourceStrictness -> Rep SourceStrictness x # to :: Rep SourceStrictness x -> SourceStrictness #
Generic DecidedStrictness
Instance details Defined in GHC.Generics Associated Types type Rep DecidedStrictness :: * -> * # Methods from :: DecidedStrictness -> Rep DecidedStrictness x # to :: Rep DecidedStrictness x -> DecidedStrictness #
Generic URI
Instance details Defined in Network.URI Associated Types type Rep URI :: * -> * # Methods from :: URI -> Rep URI x # to :: Rep URI x -> URI #
Generic IsSecure
Instance details Defined in Servant.API.IsSecure Associated Types type Rep IsSecure :: * -> * # Methods from :: IsSecure -> Rep IsSecure x # to :: Rep IsSecure x -> IsSecure #
Generic AcceptHeader
Instance details Defined in Servant.API.ContentTypes Associated Types type Rep AcceptHeader :: * -> * # Methods from :: AcceptHeader -> Rep AcceptHeader x # to :: Rep AcceptHeader x -> AcceptHeader #
Generic NoContent
Instance details Defined in Servant.API.ContentTypes Associated Types type Rep NoContent :: * -> * # Methods from :: NoContent -> Rep NoContent x # to :: Rep NoContent x -> NoContent #
Generic [a]
Instance details Defined in GHC.Generics Associated Types type Rep [a] :: * -> * # Methods from :: [a] -> Rep [a] x # to :: Rep [a] x -> [a] #
Generic (Maybe a)
Instance details Defined in GHC.Generics Associated Types type Rep (Maybe a) :: * -> * # Methods from :: Maybe a -> Rep (Maybe a) x # to :: Rep (Maybe a) x -> Maybe a #
Generic (Par1 p)
Instance details Defined in GHC.Generics Associated Types type Rep (Par1 p) :: * -> * # Methods from :: Par1 p -> Rep (Par1 p) x # to :: Rep (Par1 p) x -> Par1 p #
Generic (NonEmpty a)
Instance details Defined in GHC.Generics Associated Types type Rep (NonEmpty a) :: * -> * # Methods from :: NonEmpty a -> Rep (NonEmpty a) x # to :: Rep (NonEmpty a) x -> NonEmpty a #
Generic (BasicAuthResult usr)
Instance details Defined in Servant.Server.Internal.BasicAuth Associated Types type Rep (BasicAuthResult usr) :: * -> * # Methods from :: BasicAuthResult usr -> Rep (BasicAuthResult usr) x # to :: Rep (BasicAuthResult usr) x -> BasicAuthResult usr #
Generic (BasicAuthCheck usr)
Instance details Defined in Servant.Server.Internal.BasicAuth Associated Types type Rep (BasicAuthCheck usr) :: * -> * # Methods from :: BasicAuthCheck usr -> Rep (BasicAuthCheck usr) x # to :: Rep (BasicAuthCheck usr) x -> BasicAuthCheck usr #
Generic (Handler a)
Instance details Defined in Servant.Server.Internal.Handler 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)
Instance details Defined in GHC.Generics 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 (V1 p)
Instance details Defined in GHC.Generics Associated Types type Rep (V1 p) :: * -> * # Methods from :: V1 p -> Rep (V1 p) x # to :: Rep (V1 p) x -> V1 p #
Generic (U1 p)
Instance details Defined in GHC.Generics Associated Types type Rep (U1 p) :: * -> * # Methods from :: U1 p -> Rep (U1 p) x # to :: Rep (U1 p) x -> U1 p #
Generic (a, b)
Instance details Defined in GHC.Generics Associated Types type Rep (a, b) :: * -> * # Methods from :: (a, b) -> Rep (a, b) x # to :: Rep (a, b) x -> (a, b) #
Generic (Proxy t)
Instance details Defined in GHC.Generics Associated Types type Rep (Proxy t) :: * -> * # Methods from :: Proxy t -> Rep (Proxy t) x # to :: Rep (Proxy t) x -> Proxy t #
Generic (Rec1 f p)
Instance details Defined in GHC.Generics 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 (Ptr ()) p)
Instance details Defined in GHC.Generics 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 (URec Char p)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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 (a, b, c)
Instance details Defined in GHC.Generics 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 s b)
Instance details Defined in Data.Tagged Associated Types type Rep (Tagged s b) :: * -> * # Methods from :: Tagged s b -> Rep (Tagged s b) x # to :: Rep (Tagged s b) x -> Tagged s b #
Generic (K1 i c p)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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)
Instance details Defined in GHC.Generics 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, d)
Instance details Defined in GHC.Generics 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 (M1 i c f p)
Instance details Defined in GHC.Generics 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 ((f :.: g) p)
Instance details Defined in GHC.Generics 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, d, e)
Instance details Defined in GHC.Generics 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 (Verb method statusCode contentTypes a)
Instance details Defined in Servant.API.Verbs Associated Types type Rep (Verb method statusCode contentTypes a) :: * -> * # Methods from :: Verb method statusCode contentTypes a -> Rep (Verb method statusCode contentTypes a) x # to :: Rep (Verb method statusCode contentTypes a) x -> Verb method statusCode contentTypes a #
Generic (a, b, c, d, e, f)
Instance details Defined in GHC.Generics 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 (Stream method status framing contentType a)
Instance details Defined in Servant.API.Stream Associated Types type Rep (Stream method status framing contentType a) :: * -> * # Methods from :: Stream method status framing contentType a -> Rep (Stream method status framing contentType a) x # to :: Rep (Stream method status framing contentType a) x -> Stream method status framing contentType a #
Generic (a, b, c, d, e, f, g)
Instance details Defined in GHC.Generics 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 Link Source #

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