Safe Haskell	None
Language	Haskell2010

Servant.Foreign

Description

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

Synopsis

data ArgType
- = Normal
- | Flag
- | List
data HeaderArg f
- = HeaderArg {
  - _headerArg :: Arg f
  }
- | ReplaceHeaderArg {
  - _headerArg :: Arg f
  - _headerPattern :: Text
  }
data QueryArg f = QueryArg {
- _queryArgName :: Arg f
- _queryArgType :: ArgType
}
data Req f = Req {
- _reqUrl :: Url f
- _reqMethod :: Method
- _reqHeaders :: [HeaderArg f]
- _reqBody :: Maybe f
- _reqReturnType :: Maybe f
- _reqFuncName :: FunctionName
- _reqBodyContentType :: ReqBodyContentType
}
data ReqBodyContentType
- = ReqBodyJSON
- | ReqBodyMultipart
newtype Segment f = Segment {
- unSegment :: SegmentType f
}
data SegmentType f
- = Static PathSegment
- | Cap (Arg f)
data Url f = Url {
- _path :: Path f
- _queryStr :: [QueryArg f]
}
type Path f = [Segment f]
data Arg f = Arg {
- _argName :: PathSegment
- _argType :: f
}
newtype FunctionName = FunctionName {
- unFunctionName :: [Text]
}
newtype PathSegment = PathSegment {
- unPathSegment :: Text
}
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)
reqBodyContentType :: forall f. Lens' (Req f) ReqBodyContentType
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
- type Foreign ftype api :: *
- foreignFor :: Proxy lang -> Proxy ftype -> Proxy api -> Req ftype -> Foreign ftype api
class HasForeignType lang ftype a where
- typeFor :: Proxy lang -> Proxy ftype -> Proxy a -> ftype
class GenerateList ftype reqs where
- generateList :: reqs -> [Req ftype]
data NoTypes
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]
module Servant.API
module Servant.Foreign.Inflections

Documentation

data ArgType Source #

Constructors

Normal
Flag
List

Instances

Eq ArgType Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: ArgType -> ArgType -> Bool # (/=) :: ArgType -> ArgType -> Bool #
Data ArgType Source #
Instance details Defined in Servant.Foreign.Internal 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 Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> ArgType -> ShowS # show :: ArgType -> String # showList :: [ArgType] -> ShowS #

data HeaderArg f Source #

Constructors

HeaderArg
Fields _headerArg :: Arg f
ReplaceHeaderArg
Fields _headerArg :: Arg f _headerPattern :: Text

Instances

Eq f => Eq (HeaderArg f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: HeaderArg f -> HeaderArg f -> Bool # (/=) :: HeaderArg f -> HeaderArg f -> Bool #
Data f => Data (HeaderArg f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> HeaderArg f -> ShowS # show :: HeaderArg f -> String # showList :: [HeaderArg f] -> ShowS #

data QueryArg f Source #

Constructors

QueryArg
Fields _queryArgName :: Arg f _queryArgType :: ArgType

Instances

Eq f => Eq (QueryArg f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: QueryArg f -> QueryArg f -> Bool # (/=) :: QueryArg f -> QueryArg f -> Bool #
Data f => Data (QueryArg f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> QueryArg f -> ShowS # show :: QueryArg f -> String # showList :: [QueryArg f] -> ShowS #

data Req f Source #

Constructors

Req
Fields _reqUrl :: Url f _reqMethod :: Method _reqHeaders :: [HeaderArg f] _reqBody :: Maybe f _reqReturnType :: Maybe f _reqFuncName :: FunctionName _reqBodyContentType :: ReqBodyContentType

Instances

GenerateList ftype (Req ftype) Source #
Instance details Defined in Servant.Foreign.Internal Methods generateList :: Req ftype -> [Req ftype] Source #
Eq f => Eq (Req f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: Req f -> Req f -> Bool # (/=) :: Req f -> Req f -> Bool #
Data f => Data (Req f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> Req f -> ShowS # show :: Req f -> String # showList :: [Req f] -> ShowS #

data ReqBodyContentType Source #

Constructors

ReqBodyJSON
ReqBodyMultipart

Instances

Eq ReqBodyContentType Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: ReqBodyContentType -> ReqBodyContentType -> Bool # (/=) :: ReqBodyContentType -> ReqBodyContentType -> Bool #
Data ReqBodyContentType Source #
Instance details Defined in Servant.Foreign.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReqBodyContentType -> c ReqBodyContentType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReqBodyContentType # toConstr :: ReqBodyContentType -> Constr # dataTypeOf :: ReqBodyContentType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReqBodyContentType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReqBodyContentType) # gmapT :: (forall b. Data b => b -> b) -> ReqBodyContentType -> ReqBodyContentType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReqBodyContentType -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReqBodyContentType -> r # gmapQ :: (forall d. Data d => d -> u) -> ReqBodyContentType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReqBodyContentType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReqBodyContentType -> m ReqBodyContentType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReqBodyContentType -> m ReqBodyContentType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReqBodyContentType -> m ReqBodyContentType #
Read ReqBodyContentType Source #
Instance details Defined in Servant.Foreign.Internal Methods readsPrec :: Int -> ReadS ReqBodyContentType # readList :: ReadS [ReqBodyContentType] # readPrec :: ReadPrec ReqBodyContentType # readListPrec :: ReadPrec [ReqBodyContentType] #
Show ReqBodyContentType Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> ReqBodyContentType -> ShowS # show :: ReqBodyContentType -> String # showList :: [ReqBodyContentType] -> ShowS #

newtype Segment f Source #

Constructors

Segment
Fields unSegment :: SegmentType f

Instances

Eq f => Eq (Segment f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: Segment f -> Segment f -> Bool # (/=) :: Segment f -> Segment f -> Bool #
Data f => Data (Segment f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> Segment f -> ShowS # show :: Segment f -> String # showList :: [Segment f] -> ShowS #

data SegmentType f Source #

Constructors

Static PathSegment	a static path segment. like "/foo"
Cap (Arg f)	a capture. like "/:userid"

Instances

Eq f => Eq (SegmentType f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: SegmentType f -> SegmentType f -> Bool # (/=) :: SegmentType f -> SegmentType f -> Bool #
Data f => Data (SegmentType f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> SegmentType f -> ShowS # show :: SegmentType f -> String # showList :: [SegmentType f] -> ShowS #

data Url f Source #

Constructors

Url
Fields _path :: Path f _queryStr :: [QueryArg f]

Instances

Eq f => Eq (Url f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: Url f -> Url f -> Bool # (/=) :: Url f -> Url f -> Bool #
Data f => Data (Url f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> Url f -> ShowS # show :: Url f -> String # showList :: [Url f] -> ShowS #

type Path f = [Segment f] Source #

data Arg f Source #

Constructors

Arg
Fields _argName :: PathSegment _argType :: f

Instances

Eq f => Eq (Arg f) Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: Arg f -> Arg f -> Bool # (/=) :: Arg f -> Arg f -> Bool #
Data f => Data (Arg f) Source #
Instance details Defined in Servant.Foreign.Internal 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) Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> Arg f -> ShowS # show :: Arg f -> String # showList :: [Arg f] -> ShowS #

newtype FunctionName Source #

Constructors

FunctionName
Fields unFunctionName :: [Text]

Instances

Eq FunctionName Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: FunctionName -> FunctionName -> Bool # (/=) :: FunctionName -> FunctionName -> Bool #
Data FunctionName Source #
Instance details Defined in Servant.Foreign.Internal 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 Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> FunctionName -> ShowS # show :: FunctionName -> String # showList :: [FunctionName] -> ShowS #
Semigroup FunctionName Source #
Instance details Defined in Servant.Foreign.Internal Methods (<>) :: FunctionName -> FunctionName -> FunctionName # sconcat :: NonEmpty FunctionName -> FunctionName # stimes :: Integral b => b -> FunctionName -> FunctionName #
Monoid FunctionName Source #
Instance details Defined in Servant.Foreign.Internal Methods mempty :: FunctionName # mappend :: FunctionName -> FunctionName -> FunctionName # mconcat :: [FunctionName] -> FunctionName #

newtype PathSegment Source #

Constructors

PathSegment
Fields unPathSegment :: Text

Instances

Eq PathSegment Source #
Instance details Defined in Servant.Foreign.Internal Methods (==) :: PathSegment -> PathSegment -> Bool # (/=) :: PathSegment -> PathSegment -> Bool #
Data PathSegment Source #
Instance details Defined in Servant.Foreign.Internal 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 Source #
Instance details Defined in Servant.Foreign.Internal Methods showsPrec :: Int -> PathSegment -> ShowS # show :: PathSegment -> String # showList :: [PathSegment] -> ShowS #
IsString PathSegment Source #
Instance details Defined in Servant.Foreign.Internal Methods fromString :: String -> PathSegment #
Semigroup PathSegment Source #
Instance details Defined in Servant.Foreign.Internal Methods (<>) :: PathSegment -> PathSegment -> PathSegment # sconcat :: NonEmpty PathSegment -> PathSegment # stimes :: Integral b => b -> PathSegment -> PathSegment #
Monoid PathSegment Source #
Instance details Defined in Servant.Foreign.Internal Methods mempty :: PathSegment # mappend :: PathSegment -> PathSegment -> PathSegment # mconcat :: [PathSegment] -> PathSegment #

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

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

argPath :: Getter (Arg f) Text Source #

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

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

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

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

reqBodyContentType :: forall f. Lens' (Req f) ReqBodyContentType Source #

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

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

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

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

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

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

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

_PathSegment :: Iso' PathSegment Text Source #

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

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

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

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

_Normal :: Prism' ArgType () Source #

_Flag :: Prism' ArgType () Source #

_List :: Prism' ArgType () Source #

class HasForeign lang ftype (api :: *) where Source #

Associated Types

type Foreign ftype api :: * Source #

Methods

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

Instances

HasForeign (lang :: k) ftype Raw Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype Raw :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy Raw -> Req ftype -> Foreign ftype Raw Source #
HasForeign (lang :: k) ftype EmptyAPI Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype EmptyAPI :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy EmptyAPI -> Req ftype -> Foreign ftype EmptyAPI Source #
(HasForeignType lang ftype NoContent, ReflectMethod method) => HasForeign (lang :: k) ftype (NoContentVerb method) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (NoContentVerb method) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (NoContentVerb method) -> Req ftype -> Foreign ftype (NoContentVerb method) Source #
(HasForeign lang ftype a, HasForeign lang ftype b) => HasForeign (lang :: k) ftype (a :<\|> b) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (a :<\|> b) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (a :<\|> b) -> Req ftype -> Foreign ftype (a :<\|> b) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (Description desc :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Description desc :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Description desc :> api) -> Req ftype -> Foreign ftype (Description desc :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (Summary desc :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Summary desc :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Summary desc :> api) -> Req ftype -> Foreign ftype (Summary desc :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (HttpVersion :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (HttpVersion :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (HttpVersion :> api) -> Req ftype -> Foreign ftype (HttpVersion :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (WithNamedContext name context api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (WithNamedContext name context api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (WithNamedContext name context api) -> Req ftype -> Foreign ftype (WithNamedContext name context api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (Vault :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Vault :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Vault :> api) -> Req ftype -> Foreign ftype (Vault :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (IsSecure :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (IsSecure :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (IsSecure :> api) -> Req ftype -> Foreign ftype (IsSecure :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (RemoteHost :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (RemoteHost :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (RemoteHost :> api) -> Req ftype -> Foreign ftype (RemoteHost :> api) Source #
(KnownSymbol path, HasForeign lang ftype api) => HasForeign (lang :: k) ftype (path :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (path :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (path :> api) -> Req ftype -> Foreign ftype (path :> api) Source #
HasForeign lang ftype api => HasForeign (lang :: k) ftype (StreamBody' mods framing ctype a :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (StreamBody' mods framing ctype a :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (StreamBody' mods framing ctype a :> api) -> Req ftype -> Foreign ftype (StreamBody' mods framing ctype a :> api) Source #
(Elem JSON list, HasForeignType lang ftype a, HasForeign lang ftype api) => HasForeign (lang :: k) ftype (ReqBody' mods list a :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (ReqBody' mods list a :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (ReqBody' mods list a :> api) -> Req ftype -> Foreign ftype (ReqBody' mods list a :> api) Source #
(KnownSymbol sym, HasForeignType lang ftype Bool, HasForeign lang ftype api) => HasForeign (lang :: k) ftype (QueryFlag sym :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (QueryFlag sym :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (QueryFlag sym :> api) -> Req ftype -> Foreign ftype (QueryFlag sym :> api) Source #
(KnownSymbol sym, HasForeignType lang ftype [a], HasForeign lang ftype api) => HasForeign (lang :: k) ftype (QueryParams sym a :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (QueryParams sym a :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (QueryParams sym a :> api) -> Req ftype -> Foreign ftype (QueryParams sym a :> api) Source #
(KnownSymbol sym, HasForeignType lang ftype (RequiredArgument mods a), HasForeign lang ftype api) => HasForeign (lang :: k) ftype (QueryParam' mods sym a :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (QueryParam' mods sym a :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (QueryParam' mods sym a :> api) -> Req ftype -> Foreign ftype (QueryParam' mods sym a :> api) Source #
(KnownSymbol sym, HasForeignType lang ftype (RequiredArgument mods a), HasForeign lang ftype api) => HasForeign (lang :: k) ftype (Header' mods sym a :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Header' mods sym a :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Header' mods sym a :> api) -> Req ftype -> Foreign ftype (Header' mods sym a :> api) Source #
(KnownSymbol sym, HasForeignType lang ftype [t], HasForeign lang ftype sublayout) => HasForeign (lang :: k) ftype (CaptureAll sym t :> sublayout) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (CaptureAll sym t :> sublayout) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (CaptureAll sym t :> sublayout) -> Req ftype -> Foreign ftype (CaptureAll sym t :> sublayout) Source #
(KnownSymbol sym, HasForeignType lang ftype t, HasForeign lang ftype api) => HasForeign (lang :: k) ftype (Capture' mods sym t :> api) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Capture' mods sym t :> api) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Capture' mods sym t :> api) -> Req ftype -> Foreign ftype (Capture' mods sym t :> api) Source #
(Elem JSON list, HasForeignType lang ftype a, ReflectMethod method) => HasForeign (lang :: k) ftype (Verb method status list a) Source #
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Verb method status list a) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Verb method status list a) -> Req ftype -> Foreign ftype (Verb method status list a) Source #
(ct ~ JSON, HasForeignType lang ftype a, ReflectMethod method) => HasForeign (lang :: k) ftype (Stream method status framing ct a) Source #	TODO: doesn't taking framing into account.
Instance details Defined in Servant.Foreign.Internal Associated Types type Foreign ftype (Stream method status framing ct a) :: Type Source # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy (Stream method status framing ct a) -> Req ftype -> Foreign ftype (Stream method status framing ct a) Source #

class HasForeignType lang ftype a where Source #

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

Methods

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

Instances

HasForeignType NoTypes NoContent (ftype :: k) Source #
Instance details Defined in Servant.Foreign.Internal Methods typeFor :: Proxy NoTypes -> Proxy NoContent -> Proxy ftype -> NoContent Source #

class GenerateList ftype reqs where Source #

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.

Methods

generateList :: reqs -> [Req ftype] Source #

Instances

GenerateList ftype EmptyForeignAPI Source #
Instance details Defined in Servant.Foreign.Internal Methods generateList :: EmptyForeignAPI -> [Req ftype] Source #
GenerateList ftype (Req ftype) Source #
Instance details Defined in Servant.Foreign.Internal Methods generateList :: Req ftype -> [Req ftype] Source #
(GenerateList ftype start, GenerateList ftype rest) => GenerateList ftype (start :<\|> rest) Source #
Instance details Defined in Servant.Foreign.Internal Methods generateList :: (start :<\|> rest) -> [Req ftype] Source #

data NoTypes Source #

Instances

HasForeignType NoTypes NoContent (ftype :: k) Source #
Instance details Defined in Servant.Foreign.Internal Methods typeFor :: Proxy NoTypes -> Proxy NoContent -> Proxy ftype -> NoContent Source #

captureArg :: Segment f -> Arg f Source #

isCapture :: Segment f -> Bool Source #

defReq :: Req ftype Source #

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

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