types-kotlinx-serialization/org.kotools.types.kotlinx.serialization/KotoolsTypesSerializersModule

KotoolsTypesSerializersModule

@ExperimentalKotoolsTypesApi

@ExperimentalSince(version = KotoolsTypesVersion.V5_0_1)

fun KotoolsTypesSerializersModule(): SerializersModule

Returns a collection of default serializers used for serializing types provided by Kotools Types.

Default serializers

Here's the list of serializers used by default for each type:

EmailAddress - EmailAddress.Companion.stringSerializer
EmailAddressRegex - EmailAddressRegex.Companion.stringSerializer
Zero - Zero.Companion.intSerializer

Calling from Kotlin

Here's an example of Kotlin code that encodes and decodes the EmailAddress type using the JavaScript Object Notation (JSON) format from kotlinx.serialization and this function:

val format = Json {
    serializersModule = KotoolsTypesSerializersModule()
}
val address: EmailAddress = EmailAddress.orThrow("contact@kotools.org")
val encoded: String = format.encodeToString(address)
assertEquals(expected = "\"$address\"", encoded)
val decoded: EmailAddress = format.decodeFromString(encoded)
assertEquals(expected = address, decoded)