kotlinx-serialization-hocon/kotlinx.serialization.hocon

Package-level declarations

HOCON serialization format implementation for converting Kotlin classes from and to Lightbend config.

Types

Hocon

@ExperimentalSerializationApi

sealed class Hocon : SerialFormat

Allows deserialization of Config object from popular Lightbend/config library into Kotlin objects.

HoconBuilder

@ExperimentalSerializationApi

class HoconBuilder

Builder of the Hocon instance provided by Hocon factory function.

HoconDecoder

@ExperimentalSerializationApi

sealed interface HoconDecoder

Decoder used by Hocon during deserialization. This interface allows to call methods from the Lightbend/config library on the Config object to intercept default deserialization process.

HoconEncoder

@ExperimentalSerializationApi

sealed interface HoconEncoder

Encoder used by Hocon during serialization. This interface allows intercepting serialization process and insertion of arbitrary ConfigValue into the output.

Functions

decodeFromConfig

@ExperimentalSerializationApi

inline fun <T> Hocon.decodeFromConfig(config: Config): T

Decodes the given config into a value of type T using a deserializer retrieved from the reified type parameter.

encodeToConfig

@ExperimentalSerializationApi

inline fun <T> Hocon.encodeToConfig(value: T): Config

Encodes the given value of type T into a Config using a serializer retrieved from the reified type parameter.

Hocon

@ExperimentalSerializationApi

fun Hocon(from: Hocon = Hocon, builderAction: HoconBuilder.() -> Unit): Hocon

Creates an instance of Hocon configured from the optionally given Hocon instance and adjusted with builderAction.