micro_utils.dokka/dev.inmo.micro_utils.serialization.typed_serializer/TypedSerializer

TypedSerializer

open class TypedSerializer<T : Any>(kClass: KClass<T>, presetSerializers: Map<String, KSerializer<out T>> = emptyMap()) : KSerializer<T> (source)

A serializer that includes type information in the serialized output. This allows polymorphic serialization where the exact type is preserved in the output as a "type" field alongside the "value" field.

The serialized format is: {"type": "TypeName", "value": {...}}

Parameters

kClass

The Kotlin class of the base type

presetSerializers

A map of type names to their serializers for known subtypes

Type Parameters

The base type that this serializer handles

Constructors

TypedSerializer

constructor(kClass: KClass<T>, presetSerializers: Map<String, KSerializer<out T>> = emptyMap())

Properties

descriptor

open override val descriptor: SerialDescriptor

Functions

deserialize

open override fun deserialize(decoder: Decoder): T

exclude

open fun exclude(type: String)

Removes a type from this serializer by its name.

include

open fun <O : T> include(type: String, serializer: KSerializer<O>)

Adds a new type to this serializer with its associated serializer.

mapDeserialization

inline fun DeserializationStrategy.mapDeserialization(noinline deserialize: (I) -> O): MapperDeserializationStrategy<I, O>

Will create MapperDeserializationStrategy to allow you to map I to O using deserialize lambda during deserialization process

mapFullSerialization

inline fun KSerializer.mapFullSerialization(noinline serialize: (O) -> I, noinline deserialize: (I) -> O): MapperSerializer<I, O>

Will create MapperSerializer to allow you to map O to I and vice verse using serialize/deserialize lambda during serialization/deserialization process

mapSerialization

inline fun SerializationStrategy.mapSerialization(noinline serialize: (O) -> I): MapperSerializationStrategy<I, O>

Will create MapperSerializationStrategy to allow you to map O to I using serialize lambda during serialization process

minusAssign

@InternalSerializationApi

operator fun <T : Any> TypedSerializer<T>.minusAssign(kClass: KClass<T>)

Removes a type from this TypedSerializer using its class name.

plusAssign

@InternalSerializationApi

operator fun <T : Any> TypedSerializer<T>.plusAssign(kClass: KClass<T>)

Adds a type to this TypedSerializer using its class name as the type identifier.

serialize

open override fun serialize(encoder: Encoder, value: T)