tomlkt/net.peanuuutz.tomlkt

Package-level declarations

Types

sealed class Toml : StringFormat

The main entry point to use TOML.

@Serializable(with = TomlArraySerializer::class)

class TomlArray : TomlElement, List<TomlElement>

Represents array in TOML, which values are TomlElement.

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlBlockArray(val itemsPerLine: Int = 1)

Modify the encoding of corresponding array-like property, either to force array of tables to be encoded as block array, or to change how many items will be encoded per line (will override TomlConfig).

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlComment(val text: String)

Add comments to corresponding property.

TomlConfigBuilder

class TomlConfigBuilder

Builder provided for Toml { ... } factory function.

interface TomlDecoder : Decoder

A special Decoder which is used internally by decoding process of Toml, providing an extra decodeTomlElement to decode TomlElement from the current position.

@Serializable(with = TomlElementSerializer::class)

sealed class TomlElement

Represents anything in TOML, including and only including TomlNull, TomlLiteral, TomlArray, TomlTable.

interface TomlEncoder : Encoder

A special Encoder which is used internally by encoding process of Toml, providing an extra encodeTomlElement to encode TomlElement to the current position.

TomlIndentation

value class TomlIndentation(val representation: String)

Indicates indentation representation in string output.

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlInline

Force inline the corresponding array-like or table-like property.

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlInteger(val base: TomlInteger.Base)

Set the representation of the corresponding Byte, Short, Int, Long property.

@Serializable(with = TomlLiteralSerializer::class)

class TomlLiteral : TomlElement

Represents literal value, which can be booleans, numbers, chars, strings.

TomlLiteralString

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlLiteralString

Mark the corresponding String property as literal when encoded.

TomlMultilineString

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class TomlMultilineString

Mark the corresponding String property as multiline when encoded.

@Serializable(with = TomlNullSerializer::class)

object TomlNull : TomlElement

Represents null.

annotation class TomlSpecific

Indicates that the corresponding type is only stable to use, but shouldn't be subclassed by any third party, otherwise unpredictable behavior may be observed.

TomlStreamWriter

class TomlStreamWriter(outputStream: OutputStream) : TomlWriter

A TomlWriter that writes TOML to outputStream.

TomlStringWriter

class TomlStringWriter : TomlWriter

A TomlWriter that writes TOML as string.

@Serializable(with = TomlTableSerializer::class)

class TomlTable : TomlElement, Map<String, TomlElement>

Represents table in TOML, which keys are strings and values are TomlElement.

interface TomlWriter

A custom writer used when encoding Model class or TomlElement to the output.

Functions

fun Decoder.asTomlDecoder(): TomlDecoder

More convenient approach to cast this Decoder to TomlDecoder.

fun Encoder.asTomlEncoder(): TomlEncoder

More convenient approach to cast this Decoder to TomlEncoder.

decodeFromTomlElement

inline fun <T> Toml.decodeFromTomlElement(element: TomlElement): T

Deserializes element into a value of type T using serializer retrieved from reified type parameter.

inline fun <T> Toml.encodeToStream(value: T, outputStream: OutputStream)

Serializes value into outputStream using serializer retrieved from reified type parameter.

fun <T> Toml.encodeToStream(serializer: SerializationStrategy<T>, value: T, outputStream: OutputStream)

Serializes value into outputStream using serializer.

encodeToTomlElement

inline fun <T> Toml.encodeToTomlElement(value: T): TomlElement

Serializes value into TomlElement using serializer retrieved from reified type parameter.

inline fun <T> Toml.encodeToWriter(value: T, writer: TomlWriter)

Serializes value into writer using serializer retrieved from reified type parameter.

operator fun TomlTable.get(vararg keys: Any?): TomlElement?

Get value along with path constructed by keys.

fun TomlLiteral.toBoolean(): Boolean

Returns content as boolean.

toBooleanOrNull

fun TomlLiteral.toBooleanOrNull(): Boolean?

Returns content as boolean only if content is "true" or "false", otherwise null.

fun TomlLiteral.toByte(): Byte

Returns content as byte.

fun TomlLiteral.toByteOrNull(): Byte?

Returns content as byte only if content can be byte, otherwise null.

fun TomlLiteral.toChar(): Char

Returns content as char.

fun TomlLiteral.toCharOrNull(): Char?

Returns content as char only if the length of content is exactly 1, otherwise null.

fun TomlLiteral.toDouble(): Double

Returns content as double.

fun TomlLiteral.toDoubleOrNull(): Double?

Returns content as double only if content can be an exact double or inf/-inf/nan, otherwise null.

inline fun <E : Enum<E>> TomlLiteral.toEnum(serializersModule: SerializersModule = EmptySerializersModule()): E

Returns content as enum with given enum class context.

inline fun <E : Enum<E>> TomlLiteral.toEnumOrNull(serializersModule: SerializersModule = EmptySerializersModule()): E?

Returns content as enum with given enum class context only if content suits in, otherwise null.

fun TomlLiteral.toFloat(): Float

Returns content as float.

fun TomlLiteral.toFloatOrNull(): Float?

Returns content as float only if content can be an exact float or inf/-inf/nan, otherwise null.

fun TomlLiteral.toInt(): Int

Returns content as int.

fun TomlLiteral.toIntOrNull(): Int?

Returns content as int only if content can be int, otherwise null.

fun TomlLiteral.toLong(): Long

Returns content as long.

fun TomlLiteral.toLongOrNull(): Long?

Returns content as long only if content can be long, otherwise null.

inline fun Toml(from: Toml = Toml, config: TomlConfigBuilder.() -> Unit): Toml

Factory function for creating custom instance of Toml.

fun TomlArray(value: Iterable<*>): TomlArray

Creates TomlArray from the given iterable value.

fun TomlLiteral(value: Boolean): TomlLiteral

Creates TomlLiteral from the given boolean value.

fun TomlLiteral(value: Char): TomlLiteral

Creates TomlLiteral from the given char value.

fun TomlLiteral(value: Number): TomlLiteral

Creates TomlLiteral from the given numeric value.

fun TomlLiteral(value: String): TomlLiteral

Creates TomlLiteral from the given string value.

inline fun <E : Enum<E>> TomlLiteral(value: E, serializersModule: SerializersModule = EmptySerializersModule()): TomlLiteral

Creates TomlLiteral from the given enum value. Delegates to creator function which consumes string.

fun TomlTable(value: Map<*, *>): TomlTable

Creates TomlTable from the given map value.

fun TomlLiteral.toShort(): Short

Returns content as short.

fun TomlLiteral.toShortOrNull(): Short?

Returns content as short only if content can be short, otherwise null.

fun TomlElement.toTomlArray(): TomlArray

Convert this to TomlArray.

fun TomlElement.toTomlLiteral(): TomlLiteral

Convert this to TomlLiteral.

fun TomlElement.toTomlNull(): TomlNull

Convert this to TomlNull.

fun TomlElement.toTomlTable(): TomlTable

Convert this to TomlTable.