Servant.Foreign

Generalizes all the data needed to make code generation work with arbitrary programming languages.

Documentation

data ArgType

Constructors

Normal

Flag

List

Instances

Eq ArgType

Methods

(==) :: ArgType -> ArgType -> Bool

(/=) :: ArgType -> ArgType -> Bool

Data ArgType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ArgType -> c ArgType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ArgType

toConstr :: ArgType -> Constr

dataTypeOf :: ArgType -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ArgType)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ArgType)

gmapT :: (forall b. Data b => b -> b) -> ArgType -> ArgType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ArgType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ArgType -> r

gmapQ :: (forall d. Data d => d -> u) -> ArgType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ArgType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ArgType -> m ArgType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ArgType -> m ArgType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ArgType -> m ArgType

Show ArgType

Methods

showsPrec :: Int -> ArgType -> ShowS

show :: ArgType -> String

showList :: [ArgType] -> ShowS

data HeaderArg f

Constructors

HeaderArg

Fields

• _headerArg :: Arg f

ReplaceHeaderArg

Fields

• _headerArg :: Arg f
• _headerPattern :: Text

Instances

Eq f => Eq (HeaderArg f)

Methods

(==) :: HeaderArg f -> HeaderArg f -> Bool

(/=) :: HeaderArg f -> HeaderArg f -> Bool

Data f => Data (HeaderArg f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HeaderArg f -> c (HeaderArg f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (HeaderArg f)

toConstr :: HeaderArg f -> Constr

dataTypeOf :: HeaderArg f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (HeaderArg f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (HeaderArg f))

gmapT :: (forall b. Data b => b -> b) -> HeaderArg f -> HeaderArg f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HeaderArg f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HeaderArg f -> r

gmapQ :: (forall d. Data d => d -> u) -> HeaderArg f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> HeaderArg f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HeaderArg f -> m (HeaderArg f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HeaderArg f -> m (HeaderArg f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HeaderArg f -> m (HeaderArg f)

Show f => Show (HeaderArg f)

Methods

showsPrec :: Int -> HeaderArg f -> ShowS

show :: HeaderArg f -> String

showList :: [HeaderArg f] -> ShowS

data QueryArg f

Constructors

QueryArg

Fields

• _queryArgName :: Arg f
• _queryArgType :: ArgType

Instances

Eq f => Eq (QueryArg f)

Methods

(==) :: QueryArg f -> QueryArg f -> Bool

(/=) :: QueryArg f -> QueryArg f -> Bool

Data f => Data (QueryArg f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryArg f -> c (QueryArg f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (QueryArg f)

toConstr :: QueryArg f -> Constr

dataTypeOf :: QueryArg f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (QueryArg f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (QueryArg f))

gmapT :: (forall b. Data b => b -> b) -> QueryArg f -> QueryArg f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryArg f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryArg f -> r

gmapQ :: (forall d. Data d => d -> u) -> QueryArg f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryArg f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryArg f -> m (QueryArg f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryArg f -> m (QueryArg f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryArg f -> m (QueryArg f)

Show f => Show (QueryArg f)

Methods

showsPrec :: Int -> QueryArg f -> ShowS

show :: QueryArg f -> String

showList :: [QueryArg f] -> ShowS

data Req f

Constructors

Req

Fields

• _reqUrl :: Url f
• _reqMethod :: Method
• _reqHeaders :: [HeaderArg f]
• _reqBody :: Maybe f
• _reqReturnType :: Maybe f
• _reqFuncName :: FunctionName

Instances

GenerateList ftype (Req ftype)

Methods

generateList :: Req ftype -> [Req ftype]

Eq f => Eq (Req f)

Methods

(==) :: Req f -> Req f -> Bool

(/=) :: Req f -> Req f -> Bool

Data f => Data (Req f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Req f -> c (Req f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Req f)

toConstr :: Req f -> Constr

dataTypeOf :: Req f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (Req f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Req f))

gmapT :: (forall b. Data b => b -> b) -> Req f -> Req f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Req f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Req f -> r

gmapQ :: (forall d. Data d => d -> u) -> Req f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Req f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Req f -> m (Req f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Req f -> m (Req f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Req f -> m (Req f)

Show f => Show (Req f)

Methods

showsPrec :: Int -> Req f -> ShowS

show :: Req f -> String

showList :: [Req f] -> ShowS

newtype Segment f

Constructors

Segment

Fields

• unSegment :: SegmentType f

Instances

Eq f => Eq (Segment f)

Methods

(==) :: Segment f -> Segment f -> Bool

(/=) :: Segment f -> Segment f -> Bool

Data f => Data (Segment f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Segment f -> c (Segment f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Segment f)

toConstr :: Segment f -> Constr

dataTypeOf :: Segment f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (Segment f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Segment f))

gmapT :: (forall b. Data b => b -> b) -> Segment f -> Segment f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Segment f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Segment f -> r

gmapQ :: (forall d. Data d => d -> u) -> Segment f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Segment f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Segment f -> m (Segment f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Segment f -> m (Segment f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Segment f -> m (Segment f)

Show f => Show (Segment f)

Methods

showsPrec :: Int -> Segment f -> ShowS

show :: Segment f -> String

showList :: [Segment f] -> ShowS

data SegmentType f

Constructors

Static PathSegment

a static path segment. like "/foo"

Cap (Arg f)

a capture. like "/:userid"

Instances

Eq f => Eq (SegmentType f)

Methods

(==) :: SegmentType f -> SegmentType f -> Bool

(/=) :: SegmentType f -> SegmentType f -> Bool

Data f => Data (SegmentType f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentType f -> c (SegmentType f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SegmentType f)

toConstr :: SegmentType f -> Constr

dataTypeOf :: SegmentType f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (SegmentType f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SegmentType f))

gmapT :: (forall b. Data b => b -> b) -> SegmentType f -> SegmentType f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentType f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentType f -> r

gmapQ :: (forall d. Data d => d -> u) -> SegmentType f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentType f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentType f -> m (SegmentType f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentType f -> m (SegmentType f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentType f -> m (SegmentType f)

Show f => Show (SegmentType f)

Methods

showsPrec :: Int -> SegmentType f -> ShowS

show :: SegmentType f -> String

showList :: [SegmentType f] -> ShowS

data Url f

Constructors

Url

Fields

• _path :: Path f
• _queryStr :: [QueryArg f]

Instances

Eq f => Eq (Url f)

Methods

(==) :: Url f -> Url f -> Bool

(/=) :: Url f -> Url f -> Bool

Data f => Data (Url f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Url f -> c (Url f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Url f)

toConstr :: Url f -> Constr

dataTypeOf :: Url f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (Url f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Url f))

gmapT :: (forall b. Data b => b -> b) -> Url f -> Url f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Url f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Url f -> r

gmapQ :: (forall d. Data d => d -> u) -> Url f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Url f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Url f -> m (Url f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Url f -> m (Url f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Url f -> m (Url f)

Show f => Show (Url f)

Methods

showsPrec :: Int -> Url f -> ShowS

show :: Url f -> String

showList :: [Url f] -> ShowS

type Path f = [Segment f]

data Arg f

Constructors

Arg

Fields

• _argName :: PathSegment
• _argType :: f

Instances

Eq f => Eq (Arg f)

Methods

(==) :: Arg f -> Arg f -> Bool

(/=) :: Arg f -> Arg f -> Bool

Data f => Data (Arg f)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Arg f -> c (Arg f)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Arg f)

toConstr :: Arg f -> Constr

dataTypeOf :: Arg f -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (Arg f))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Arg f))

gmapT :: (forall b. Data b => b -> b) -> Arg f -> Arg f

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Arg f -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Arg f -> r

gmapQ :: (forall d. Data d => d -> u) -> Arg f -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Arg f -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Arg f -> m (Arg f)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Arg f -> m (Arg f)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Arg f -> m (Arg f)

Show f => Show (Arg f)

Methods

showsPrec :: Int -> Arg f -> ShowS

show :: Arg f -> String

showList :: [Arg f] -> ShowS

newtype FunctionName

Constructors

FunctionName

Fields

• unFunctionName :: [Text]

Instances

Eq FunctionName

Methods

(==) :: FunctionName -> FunctionName -> Bool

(/=) :: FunctionName -> FunctionName -> Bool

Data FunctionName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FunctionName -> c FunctionName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FunctionName

toConstr :: FunctionName -> Constr

dataTypeOf :: FunctionName -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FunctionName)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FunctionName)

gmapT :: (forall b. Data b => b -> b) -> FunctionName -> FunctionName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FunctionName -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FunctionName -> r

gmapQ :: (forall d. Data d => d -> u) -> FunctionName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FunctionName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FunctionName -> m FunctionName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FunctionName -> m FunctionName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FunctionName -> m FunctionName

Show FunctionName

Methods

showsPrec :: Int -> FunctionName -> ShowS

show :: FunctionName -> String

showList :: [FunctionName] -> ShowS

Semigroup FunctionName

Methods

(<>) :: FunctionName -> FunctionName -> FunctionName

sconcat :: NonEmpty FunctionName -> FunctionName

stimes :: Integral b => b -> FunctionName -> FunctionName

Monoid FunctionName

Methods

mempty :: FunctionName

mappend :: FunctionName -> FunctionName -> FunctionName

mconcat :: [FunctionName] -> FunctionName

newtype PathSegment

Constructors

PathSegment

Fields

• unPathSegment :: Text

Instances

Eq PathSegment

Methods

(==) :: PathSegment -> PathSegment -> Bool

(/=) :: PathSegment -> PathSegment -> Bool

Data PathSegment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PathSegment -> c PathSegment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PathSegment

toConstr :: PathSegment -> Constr

dataTypeOf :: PathSegment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PathSegment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PathSegment)

gmapT :: (forall b. Data b => b -> b) -> PathSegment -> PathSegment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PathSegment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PathSegment -> r

gmapQ :: (forall d. Data d => d -> u) -> PathSegment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PathSegment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PathSegment -> m PathSegment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PathSegment -> m PathSegment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PathSegment -> m PathSegment

Show PathSegment

Methods

showsPrec :: Int -> PathSegment -> ShowS

show :: PathSegment -> String

showList :: [PathSegment] -> ShowS

IsString PathSegment

Methods

fromString :: String -> PathSegment

Semigroup PathSegment

Methods

(<>) :: PathSegment -> PathSegment -> PathSegment

sconcat :: NonEmpty PathSegment -> PathSegment

stimes :: Integral b => b -> PathSegment -> PathSegment

Monoid PathSegment

Methods

mempty :: PathSegment

mappend :: PathSegment -> PathSegment -> PathSegment

mconcat :: [PathSegment] -> PathSegment

argName :: forall f. Lens' (Arg f) PathSegment

argType :: forall f f. Lens (Arg f) (Arg f) f f

argPath :: Getter (Arg f) Text

reqUrl :: forall f. Lens' (Req f) (Url f)

reqMethod :: forall f. Lens' (Req f) Method

reqHeaders :: forall f. Lens' (Req f) [HeaderArg f]

reqBody :: forall f. Lens' (Req f) (Maybe f)

reqReturnType :: forall f. Lens' (Req f) (Maybe f)

reqFuncName :: forall f. Lens' (Req f) FunctionName

path :: forall f. Lens' (Url f) (Path f)

queryStr :: forall f. Lens' (Url f) [QueryArg f]

queryArgName :: forall f f. Lens (QueryArg f) (QueryArg f) (Arg f) (Arg f)

queryArgType :: forall f. Lens' (QueryArg f) ArgType

headerArg :: forall f f. Lens (HeaderArg f) (HeaderArg f) (Arg f) (Arg f)

_PathSegment :: Iso' PathSegment Text

_HeaderArg :: forall f. Prism' (HeaderArg f) (Arg f)

_ReplaceHeaderArg :: forall f. Prism' (HeaderArg f) (Arg f, Text)

_Static :: forall f. Prism' (SegmentType f) PathSegment

_Cap :: forall f f. Prism (SegmentType f) (SegmentType f) (Arg f) (Arg f)

_Normal :: Prism' ArgType ()

_Flag :: Prism' ArgType ()

_List :: Prism' ArgType ()

class HasForeign lang ftype (api :: *) where

Minimal complete definition

foreignFor

Associated Types

type Foreign ftype api :: *

Methods

foreignFor :: Proxy lang -> Proxy ftype -> Proxy api -> Req ftype -> Foreign ftype api

Instances

HasForeign k lang ftype Raw

Associated Types

type Foreign Raw api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * Raw -> Proxy * api -> Req Raw -> Foreign Raw api

HasForeign k lang ftype EmptyAPI

Associated Types

type Foreign EmptyAPI api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * EmptyAPI -> Proxy * api -> Req EmptyAPI -> Foreign EmptyAPI api

(HasForeign k lang ftype a, HasForeign k lang ftype b) => HasForeign k lang ftype ((:<|>) a b)

Associated Types

type Foreign (a :<|> b) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * (a :<|> b) -> Proxy * api -> Req (a :<|> b) -> Foreign (a :<|> b) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * (Description desc) api)

Associated Types

type Foreign ((* :> Description desc) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> Description desc) api) -> Proxy * api -> Req ((* :> Description desc) api) -> Foreign ((* :> Description desc) api) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * (Summary desc) api)

Associated Types

type Foreign ((* :> Summary desc) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> Summary desc) api) -> Proxy * api -> Req ((* :> Summary desc) api) -> Foreign ((* :> Summary desc) api) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * HttpVersion api)

Associated Types

type Foreign ((* :> HttpVersion) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> HttpVersion) api) -> Proxy * api -> Req ((* :> HttpVersion) api) -> Foreign ((* :> HttpVersion) api) api

HasForeign k lang ftype api => HasForeign k lang ftype (WithNamedContext name context api)

Associated Types

type Foreign (WithNamedContext name context api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * (WithNamedContext name context api) -> Proxy * api -> Req (WithNamedContext name context api) -> Foreign (WithNamedContext name context api) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * Vault api)

Associated Types

type Foreign ((* :> Vault) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> Vault) api) -> Proxy * api -> Req ((* :> Vault) api) -> Foreign ((* :> Vault) api) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * IsSecure api)

Associated Types

type Foreign ((* :> IsSecure) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> IsSecure) api) -> Proxy * api -> Req ((* :> IsSecure) api) -> Foreign ((* :> IsSecure) api) api

HasForeign k lang ftype api => HasForeign k lang ftype ((:>) * RemoteHost api)

Associated Types

type Foreign ((* :> RemoteHost) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> RemoteHost) api) -> Proxy * api -> Req ((* :> RemoteHost) api) -> Foreign ((* :> RemoteHost) api) api

(KnownSymbol path, HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) Symbol path api)

Associated Types

type Foreign ((Symbol :> path) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((Symbol :> path) api) -> Proxy * api -> Req ((Symbol :> path) api) -> Foreign ((Symbol :> path) api) api

(Elem * JSON list, HasForeignType k * lang ftype a, HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (ReqBody' mods list a) api)

Associated Types

type Foreign ((* :> ReqBody' mods list a) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> ReqBody' mods list a) api) -> Proxy * api -> Req ((* :> ReqBody' mods list a) api) -> Foreign ((* :> ReqBody' mods list a) api) api

(KnownSymbol sym, HasForeignType k * lang ftype Bool, HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (QueryFlag sym) api)

Associated Types

type Foreign ((* :> QueryFlag sym) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> QueryFlag sym) api) -> Proxy * api -> Req ((* :> QueryFlag sym) api) -> Foreign ((* :> QueryFlag sym) api) api

(KnownSymbol sym, HasForeignType k * lang ftype [a], HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (QueryParams sym a) api)

Associated Types

type Foreign ((* :> QueryParams sym a) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> QueryParams sym a) api) -> Proxy * api -> Req ((* :> QueryParams sym a) api) -> Foreign ((* :> QueryParams sym a) api) api

(KnownSymbol sym, HasForeignType k * lang ftype (RequiredArgument mods a), HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (QueryParam' mods sym a) api)

Associated Types

type Foreign ((* :> QueryParam' mods sym a) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> QueryParam' mods sym a) api) -> Proxy * api -> Req ((* :> QueryParam' mods sym a) api) -> Foreign ((* :> QueryParam' mods sym a) api) api

(KnownSymbol sym, HasForeignType k * lang ftype (RequiredArgument mods a), HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (Header' * mods sym a) api)

Associated Types

type Foreign ((* :> Header' * mods sym a) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> Header' * mods sym a) api) -> Proxy * api -> Req ((* :> Header' * mods sym a) api) -> Foreign ((* :> Header' * mods sym a) api) api

(KnownSymbol sym, HasForeignType k * lang ftype [t], HasForeign k lang ftype sublayout) => HasForeign k lang ftype ((:>) * (CaptureAll sym t) sublayout)

Associated Types

type Foreign ((* :> CaptureAll sym t) sublayout) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> CaptureAll sym t) sublayout) -> Proxy * api -> Req ((* :> CaptureAll sym t) sublayout) -> Foreign ((* :> CaptureAll sym t) sublayout) api

(KnownSymbol sym, HasForeignType k * lang ftype t, HasForeign k lang ftype api) => HasForeign k lang ftype ((:>) * (Capture' mods sym t) api)

Associated Types

type Foreign ((* :> Capture' mods sym t) api) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * ((* :> Capture' mods sym t) api) -> Proxy * api -> Req ((* :> Capture' mods sym t) api) -> Foreign ((* :> Capture' mods sym t) api) api

(Elem * JSON list, HasForeignType k * lang ftype a, ReflectMethod k1 method) => HasForeign k lang ftype (Verb k1 method status list a)

Associated Types

type Foreign (Verb k1 method status list a) api :: *

Methods

foreignFor :: Proxy lang ftype -> Proxy * (Verb k1 method status list a) -> Proxy * api -> Req (Verb k1 method status list a) -> Foreign (Verb k1 method status list a) api

class HasForeignType lang ftype a where

HasForeignType maps Haskell types with types in the target language of your backend. For example, let's say you're implementing a backend to some language X, and you want a Text representation of each input/output type mentioned in the API:

-- First you need to create a dummy type to parametrize your
-- instances.
data LangX

-- Otherwise you define instances for the types you need
instance HasForeignType LangX Text Int where
   typeFor _ _ _ = "intX"

-- Or for example in case of lists
instance HasForeignType LangX Text a => HasForeignType LangX Text [a] where
   typeFor lang type _ = "listX of " <> typeFor lang ftype (Proxy :: Proxy a)

Finally to generate list of information about all the endpoints for an API you create a function of a form:

getEndpoints :: (HasForeign LangX Text api, GenerateList Text (Foreign Text api))
             => Proxy api -> [Req Text]
getEndpoints api = listFromAPI (Proxy :: Proxy LangX) (Proxy :: Proxy Text) api

-- If language __X__ is dynamically typed then you can use
-- a predefined NoTypes parameter with the NoContent output type:

getEndpoints :: (HasForeign NoTypes NoContent api, GenerateList Text (Foreign NoContent api))
             => Proxy api -> [Req NoContent]
getEndpoints api = listFromAPI (Proxy :: Proxy NoTypes) (Proxy :: Proxy NoContent) api

Minimal complete definition

typeFor

Methods

typeFor :: Proxy lang -> Proxy ftype -> Proxy a -> ftype

Instances

HasForeignType * k NoTypes NoContent ftype

Methods

typeFor :: Proxy NoTypes ftype -> Proxy * ftype -> Proxy NoContent a -> ftype

class GenerateList ftype reqs where

Utility class used by listFromAPI which computes the data needed to generate a function for each endpoint and hands it all back in a list.

Minimal complete definition

generateList

Methods

generateList :: reqs -> [Req ftype]

Instances

GenerateList ftype EmptyForeignAPI

Methods

generateList :: EmptyForeignAPI -> [Req ftype]

GenerateList ftype (Req ftype)

Methods

generateList :: Req ftype -> [Req ftype]

(GenerateList ftype start, GenerateList ftype rest) => GenerateList ftype ((:<|>) start rest)

Methods

generateList :: (start :<|> rest) -> [Req ftype]

data NoTypes

Instances

HasForeignType * k NoTypes NoContent ftype

Methods

typeFor :: Proxy NoTypes ftype -> Proxy * ftype -> Proxy NoContent a -> ftype

captureArg :: Segment f -> Arg f

isCapture :: Segment f -> Bool

defReq :: Req ftype

listFromAPI :: (HasForeign lang ftype api, GenerateList ftype (Foreign ftype api)) => Proxy lang -> Proxy ftype -> Proxy api -> [Req ftype]

Generate the necessary data for codegen as a list, each Req describing one endpoint from your API type.

module Servant.API

module Servant.Foreign.Inflections