kotlinx-serialization-hocon/kotlinx.serialization.hocon/Hocon

Hocon

sealed class Hocon : SerialFormat
Content copied to clipboard

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

Config object represents "Human-Optimized Config Object Notation" — https://github.com/lightbend/config#using-hocon-the-json-superset.

Parameters

useConfigNamingConvention

switches naming resolution to config naming convention (hyphen separated).

serializersModule

A SerializersModule which should contain registered serializers for Contextual and Polymorphic serialization, if you have any.

Types

Default
Link copied to clipboard
object Default : Hocon
Content copied to clipboard

The default instance of Hocon parser.

Functions

decodeFromConfig
Link copied to clipboard
fun <T> decodeFromConfig(deserializer: DeserializationStrategy<T>, config: Config): T
Content copied to clipboard

Properties

serializersModule
Link copied to clipboard
open override val serializersModule: SerializersModule
Content copied to clipboard

Inheritors

Default
Link copied to clipboard

Extensions

decodeFromConfig
Link copied to clipboard
inline fun <T> Hocon.decodeFromConfig(config: Config): T
Content copied to clipboard

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