kotlinx-serialization-properties/kotlinx.serialization.properties

Package kotlinx.serialization.properties

Properties serialization format implementation that represents the input data as a plain map of properties.

Types

Properties

Transforms a Serializable class' properties into a single flat Map consisting of string keys and primitive type values, and vice versa.

Functions

decodeFromMap

inline fun <T> Properties.decodeFromMap(map: Map<String, Any>): T

Decodes properties from given map, assigns them to an object using serializer for reified type T and returns this object. T may contain properties of nullable types; they will be filled by non-null values from the map, if present.

decodeFromStringMap

inline fun <T> Properties.decodeFromStringMap(map: Map<String, String>): T

Decodes properties from given map, assigns them to an object using serializer for reified type T and returns this object. String values are converted to respective primitive types using default conversion methods. T may contain properties of nullable types; they will be filled by non-null values from the map, if present.

encodeToMap

inline fun <T> Properties.encodeToMap(value: T): Map<String, Any>

Encodes properties from given value to a map using serializer for reified type T and returns this map. null values are omitted from the output.

encodeToStringMap

inline fun <T> Properties.encodeToStringMap(value: T): Map<String, String>

Encodes properties from given value to a map using serializer for reified type T and returns this map. Converts all primitive types to String using toString method. null values are omitted from the output.

Properties

fun Properties(module: SerializersModule): Properties

Creates an instance of Properties with a given module.