Servant.Kotlin

Documentation

generateKotlinForDefDataClass :: KotlinType a => Proxy a -> [Text]

defKotlinImports :: Text

generateKotlinForAPI :: (HasForeign LangKotlin KotlinClass api, GenerateList KotlinClass (Foreign KotlinClass api)) => Proxy api -> [Text]

Generate Kotlin code for the API with default options. Returns a list of Kotlin functions to query your Servant API from Kotlin.

generateKotlinForAPIWith :: (HasForeign LangKotlin KotlinClass api, GenerateList KotlinClass (Foreign KotlinClass api)) => KotlinOptions -> Proxy api -> [Text]

Generate Kotlin code for the API with custom options.

generateKotlinForAPIClass :: Text -> [Text] -> [Text]

data KotlinOptions

Options to configure how code is generated.

Constructors

KotlinOptions

Fields

• urlPrefix :: UrlPrefix
• emptyResponseKotlinTypes :: [KotlinClass]

  Types that represent an empty Http response.

• stringKotlinTypes :: [KotlinClass]

  Types that represent a String.

data UrlPrefix

Constructors

Static Text

Dynamic

defKotlinOptions :: KotlinOptions

Default options for generating Kotlin code. The default options are: > { urlPrefix = Static "" > , emptyResponseKotlinTypes = [ toKotlinType NoContent ] > , stringKotlinTypes = [ toKotlinType "" ] > }

data Spec

Constructors

Spec

Fields

• namespace :: [Text]
• filename :: Text
• declarations :: [Text]

Instances

Show Spec

Defined in Servant.Kotlin.Internal.File

Methods

showsPrec :: Int -> Spec -> ShowS

show :: Spec -> String

showList :: [Spec] -> ShowS

specsToDir :: [Spec] -> FilePath -> IO ()

Convenience re-exports from the Kotlin module

class KotlinType a

Instances

KotlinType Bool

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Bool -> Maybe KotlinClass

KotlinType Char

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Char -> Maybe KotlinClass

KotlinType Double

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Double -> Maybe KotlinClass

KotlinType Float

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Float -> Maybe KotlinClass

KotlinType Int

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Int -> Maybe KotlinClass

KotlinType Int8

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Int8 -> Maybe KotlinClass

KotlinType Int16

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Int16 -> Maybe KotlinClass

KotlinType Int32

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Int32 -> Maybe KotlinClass

KotlinType Int64

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Int64 -> Maybe KotlinClass

KotlinType ()

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: () -> Maybe KotlinClass

KotlinType Text

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Text -> Maybe KotlinClass

KotlinType UTCTime

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: UTCTime -> Maybe KotlinClass

KotlinType NoContent

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: NoContent -> Maybe KotlinClass

KotlinType a => KotlinType [a]

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: [a] -> Maybe KotlinClass

KotlinType a => KotlinType (Maybe a)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Maybe a -> Maybe KotlinClass

KotlinType v => KotlinType (IntMap v)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: IntMap v -> Maybe KotlinClass

(KotlinType a, KotlinType b) => KotlinType (a, b)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: (a, b) -> Maybe KotlinClass

(KotlinType k, KotlinType v) => KotlinType (Map k v)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Map k v -> Maybe KotlinClass

KotlinType a => KotlinType (Proxy a)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Proxy a -> Maybe KotlinClass

Convenience re-exports from Data.Proxy

data Proxy (t :: k) :: forall k. k -> Type

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the 'undefined :: a' idiom.

>>> Proxy :: Proxy (Void, Int -> Int)
Proxy

Proxy can even hold types of higher kinds,

>>> Proxy :: Proxy Either
Proxy

>>> Proxy :: Proxy Functor
Proxy

>>> Proxy :: Proxy complicatedStructure
Proxy

Constructors

Proxy

Instances

Generic1 (Proxy :: k -> Type)

Defined in GHC.Generics

Associated Types

type Rep1 Proxy :: k -> Type

Methods

from1 :: Proxy a -> Rep1 Proxy a

to1 :: Rep1 Proxy a -> Proxy a

Monad (Proxy :: Type -> Type)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

(>>=) :: Proxy a -> (a -> Proxy b) -> Proxy b

(>>) :: Proxy a -> Proxy b -> Proxy b

return :: a -> Proxy a

fail :: String -> Proxy a

Functor (Proxy :: Type -> Type)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

fmap :: (a -> b) -> Proxy a -> Proxy b

(<$) :: a -> Proxy b -> Proxy a

Applicative (Proxy :: Type -> Type)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

pure :: a -> Proxy a

(<*>) :: Proxy (a -> b) -> Proxy a -> Proxy b

liftA2 :: (a -> b -> c) -> Proxy a -> Proxy b -> Proxy c

(*>) :: Proxy a -> Proxy b -> Proxy b

(<*) :: Proxy a -> Proxy b -> Proxy a

Foldable (Proxy :: Type -> Type)

Since: base-4.7.0.0

Defined in Data.Foldable

Methods

fold :: Monoid m => Proxy m -> m

foldMap :: Monoid m => (a -> m) -> Proxy a -> m

foldr :: (a -> b -> b) -> b -> Proxy a -> b

foldr' :: (a -> b -> b) -> b -> Proxy a -> b

foldl :: (b -> a -> b) -> b -> Proxy a -> b

foldl' :: (b -> a -> b) -> b -> Proxy a -> b

foldr1 :: (a -> a -> a) -> Proxy a -> a

foldl1 :: (a -> a -> a) -> Proxy a -> a

toList :: Proxy a -> [a]

null :: Proxy a -> Bool

length :: Proxy a -> Int

elem :: Eq a => a -> Proxy a -> Bool

maximum :: Ord a => Proxy a -> a

minimum :: Ord a => Proxy a -> a

sum :: Num a => Proxy a -> a

product :: Num a => Proxy a -> a

Traversable (Proxy :: Type -> Type)

Since: base-4.7.0.0

Defined in Data.Traversable

Methods

traverse :: Applicative f => (a -> f b) -> Proxy a -> f (Proxy b)

sequenceA :: Applicative f => Proxy (f a) -> f (Proxy a)

mapM :: Monad m => (a -> m b) -> Proxy a -> m (Proxy b)

sequence :: Monad m => Proxy (m a) -> m (Proxy a)

Contravariant (Proxy :: Type -> Type)

Defined in Data.Functor.Contravariant

Methods

contramap :: (a -> b) -> Proxy b -> Proxy a

(>$) :: b -> Proxy b -> Proxy a

Representable (Proxy :: Type -> Type)

Defined in Data.Functor.Rep

Associated Types

type Rep Proxy :: Type

Methods

tabulate :: (Rep Proxy -> a) -> Proxy a

index :: Proxy a -> Rep Proxy -> a

Alternative (Proxy :: Type -> Type)

Since: base-4.9.0.0

Defined in Data.Proxy

Methods

empty :: Proxy a

(<|>) :: Proxy a -> Proxy a -> Proxy a

some :: Proxy a -> Proxy [a]

many :: Proxy a -> Proxy [a]

MonadPlus (Proxy :: Type -> Type)

Since: base-4.9.0.0

Defined in Data.Proxy

Methods

mzero :: Proxy a

mplus :: Proxy a -> Proxy a -> Proxy a

Bounded (Proxy t)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

minBound :: Proxy t

maxBound :: Proxy t

Enum (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

succ :: Proxy s -> Proxy s

pred :: Proxy s -> Proxy s

toEnum :: Int -> Proxy s

fromEnum :: Proxy s -> Int

enumFrom :: Proxy s -> [Proxy s]

enumFromThen :: Proxy s -> Proxy s -> [Proxy s]

enumFromTo :: Proxy s -> Proxy s -> [Proxy s]

enumFromThenTo :: Proxy s -> Proxy s -> Proxy s -> [Proxy s]

Eq (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

(==) :: Proxy s -> Proxy s -> Bool

(/=) :: Proxy s -> Proxy s -> Bool

Ord (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

compare :: Proxy s -> Proxy s -> Ordering

(<) :: Proxy s -> Proxy s -> Bool

(<=) :: Proxy s -> Proxy s -> Bool

(>) :: Proxy s -> Proxy s -> Bool

(>=) :: Proxy s -> Proxy s -> Bool

max :: Proxy s -> Proxy s -> Proxy s

min :: Proxy s -> Proxy s -> Proxy s

Read (Proxy t)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

readsPrec :: Int -> ReadS (Proxy t)

readList :: ReadS [Proxy t]

readPrec :: ReadPrec (Proxy t)

readListPrec :: ReadPrec [Proxy t]

Show (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

showsPrec :: Int -> Proxy s -> ShowS

show :: Proxy s -> String

showList :: [Proxy s] -> ShowS

Ix (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

range :: (Proxy s, Proxy s) -> [Proxy s]

index :: (Proxy s, Proxy s) -> Proxy s -> Int

unsafeIndex :: (Proxy s, Proxy s) -> Proxy s -> Int

inRange :: (Proxy s, Proxy s) -> Proxy s -> Bool

rangeSize :: (Proxy s, Proxy s) -> Int

unsafeRangeSize :: (Proxy s, Proxy s) -> Int

Generic (Proxy t)

Defined in GHC.Generics

Associated Types

type Rep (Proxy t) :: Type -> Type

Methods

from :: Proxy t -> Rep (Proxy t) x

to :: Rep (Proxy t) x -> Proxy t

Semigroup (Proxy s)

Since: base-4.9.0.0

Defined in Data.Proxy

Methods

(<>) :: Proxy s -> Proxy s -> Proxy s

sconcat :: NonEmpty (Proxy s) -> Proxy s

stimes :: Integral b => b -> Proxy s -> Proxy s

Monoid (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

mempty :: Proxy s

mappend :: Proxy s -> Proxy s -> Proxy s

mconcat :: [Proxy s] -> Proxy s

KotlinType a => KotlinType (Proxy a)

Defined in Servant.Kotlin.Type

Methods

toKotlinType :: Proxy a -> Maybe KotlinClass

type Rep1 (Proxy :: k -> Type)

Since: base-4.6.0.0

Defined in GHC.Generics

type Rep1 (Proxy :: k -> Type) = D1 (MetaData "Proxy" "Data.Proxy" "base" False) (C1 (MetaCons "Proxy" PrefixI False) (U1 :: k -> Type))

type Rep (Proxy :: Type -> Type)

Defined in Data.Functor.Rep

type Rep (Proxy :: Type -> Type) = Void

type Rep (Proxy t)

Since: base-4.6.0.0

Defined in GHC.Generics

type Rep (Proxy t) = D1 (MetaData "Proxy" "Data.Proxy" "base" False) (C1 (MetaCons "Proxy" PrefixI False) (U1 :: Type -> Type))