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

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

Methods

toKotlinType :: Bool -> Maybe KotlinClass

KotlinType Char

Methods

toKotlinType :: Char -> Maybe KotlinClass

KotlinType Double

Methods

toKotlinType :: Double -> Maybe KotlinClass

KotlinType Float

Methods

toKotlinType :: Float -> Maybe KotlinClass

KotlinType Int

Methods

toKotlinType :: Int -> Maybe KotlinClass

KotlinType Int8

Methods

toKotlinType :: Int8 -> Maybe KotlinClass

KotlinType Int16

Methods

toKotlinType :: Int16 -> Maybe KotlinClass

KotlinType Int32

Methods

toKotlinType :: Int32 -> Maybe KotlinClass

KotlinType Int64

Methods

toKotlinType :: Int64 -> Maybe KotlinClass

KotlinType ()

Methods

toKotlinType :: () -> Maybe KotlinClass

KotlinType Text

Methods

toKotlinType :: Text -> Maybe KotlinClass

KotlinType UTCTime

Methods

toKotlinType :: UTCTime -> Maybe KotlinClass

KotlinType NoContent

Methods

toKotlinType :: NoContent -> Maybe KotlinClass

KotlinType a => KotlinType [a]

Methods

toKotlinType :: [a] -> Maybe KotlinClass

KotlinType a => KotlinType (Maybe a)

Methods

toKotlinType :: Maybe a -> Maybe KotlinClass

KotlinType v => KotlinType (IntMap v)

Methods

toKotlinType :: IntMap v -> Maybe KotlinClass

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

Methods

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

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

Methods

toKotlinType :: Map k v -> Maybe KotlinClass

KotlinType a => KotlinType (Proxy * a)

Methods

toKotlinType :: Proxy * a -> Maybe KotlinClass

Convenience re-exports from Data.Proxy

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

A concrete, poly-kinded proxy type

Constructors

Proxy

Instances

Generic1 k (Proxy k)

Associated Types

type Rep1 (Proxy k) (f :: Proxy k -> *) :: k -> *

Methods

from1 :: f a -> Rep1 (Proxy k) f a

to1 :: Rep1 (Proxy k) f a -> f a

Monad (Proxy *)

Since: 4.7.0.0

Methods

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

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

return :: a -> Proxy * a

fail :: String -> Proxy * a

Functor (Proxy *)

Since: 4.7.0.0

Methods

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

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

Applicative (Proxy *)

Since: 4.7.0.0

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 *)

Since: 4.7.0.0

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

Contravariant (Proxy *)

Methods

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

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

Alternative (Proxy *)

Since: 4.9.0.0

Methods

empty :: Proxy * a

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

some :: Proxy * a -> Proxy * [a]

many :: Proxy * a -> Proxy * [a]

MonadPlus (Proxy *)

Since: 4.9.0.0

Methods

mzero :: Proxy * a

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

Bounded (Proxy k t)

Methods

minBound :: Proxy k t

maxBound :: Proxy k t

Enum (Proxy k s)

Since: 4.7.0.0

Methods

succ :: Proxy k s -> Proxy k s

pred :: Proxy k s -> Proxy k s

toEnum :: Int -> Proxy k s

fromEnum :: Proxy k s -> Int

enumFrom :: Proxy k s -> [Proxy k s]

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

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

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

Eq (Proxy k s)

Since: 4.7.0.0

Methods

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

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

Ord (Proxy k s)

Since: 4.7.0.0

Methods

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

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

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

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

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

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

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

Read (Proxy k s)

Since: 4.7.0.0

Methods

readsPrec :: Int -> ReadS (Proxy k s)

readList :: ReadS [Proxy k s]

readPrec :: ReadPrec (Proxy k s)

readListPrec :: ReadPrec [Proxy k s]

Show (Proxy k s)

Since: 4.7.0.0

Methods

showsPrec :: Int -> Proxy k s -> ShowS

show :: Proxy k s -> String

showList :: [Proxy k s] -> ShowS

Ix (Proxy k s)

Since: 4.7.0.0

Methods

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

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

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

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

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

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

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

Monoid (Proxy k s)

Since: 4.7.0.0

Methods

mempty :: Proxy k s

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

mconcat :: [Proxy k s] -> Proxy k s

KotlinType a => KotlinType (Proxy * a)

Methods

toKotlinType :: Proxy * a -> Maybe KotlinClass

type Rep1 k (Proxy k)

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

type Rep (Proxy k t)

type Rep (Proxy k t) = D1 * (MetaData "Proxy" "Data.Proxy" "base" False) (C1 * (MetaCons "Proxy" PrefixI False) (U1 *))