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

KotoolsTypesSerializersModule

@ExperimentalSince(version = KotoolsTypesVersion.V5_0_1)

fun KotoolsTypesSerializersModule(): SerializersModule

Returns a collection of default serializers for types located in org.kotools.types package.

EmailAddress

This function provides an object for serializing and deserializing an EmailAddress as String.

Here's an example of calling it, using the JavaScript Object Notation (JSON) format:

val format = Json {
    this.serializersModule = KotoolsTypesSerializersModule()
}
val emailAddress: EmailAddress? = EmailAddress.of("[email protected]")
checkNotNull(emailAddress)
val encoded: String = format.encodeToString(emailAddress)
check(encoded == "\"[email protected]\"")
val decoded: EmailAddress = format.decodeFromString(encoded)
check(decoded == emailAddress)

EmailAddressRegex

This function provides an object for serializing and deserializing an EmailAddressRegex as String.

Here's an example of calling it, using the JavaScript Object Notation (JSON) format:

val format = Json {
    this.serializersModule = KotoolsTypesSerializersModule()
}
val regex: EmailAddressRegex =
    EmailAddressRegex.default() // ^\S+@\S+\.\S+$
val encoded: String = format.encodeToString(regex)
check(encoded == "\"^\\\\S+@\\\\S+\\\\.\\\\S+$\"")
val decoded: EmailAddressRegex = format.decodeFromString(encoded)
check(decoded == regex)

Integer

This function provides an object for serializing and deserializing an Integer as String.

Here's an example of calling it, using the JavaScript Object Notation (JSON) format:

val format = Json {
    this.serializersModule = KotoolsTypesSerializersModule()
}
val integer: Integer = Integer.from(123456789)
val encoded: String = format.encodeToString(integer)
check(encoded == "\"123456789\"")
val decoded: Integer = format.decodeFromString(encoded)
check(decoded == integer)