KBigInt Serialization

The serialization module of the KBigInt library.

Add the dependency

dependencies {
    implementation("io.github.observeroftime.kbigint:kbigint-serialization")
}

repositories {
    mavenCentral()
}

Use the library

There are three ways to enable (de)serialization of KBigInt classes. The examples use kotlinx-serialization-json but any format should work.

Serializers module

You can declare a new encoder/decoder instance using the serializers module.

import io.github.observeroftime.kbigint.KBigInt
import io.github.observeroftime.kbigint.serialization.module
import kotlinx.serialization.json.*

val json = Json { serializersModule = module }

val number = KBigInt("9007199254740991")
val encoded = json.encodeToJsonElement(number)
val decoded = json.decodeFromJsonElement(encoded)

Serializable type alias

The serializable type alias defined can be used explicitly in type parameters.

NOTE: this method only works in JVM & Android.

import io.github.observeroftime.kbigint.serialization.KBigInt
import kotlinx.serialization.json.*

val number = KBigInt("9007199254740991")
val encoded = Json.encodeToJsonElement<KBigInt>(number)
val decoded = Json.decodeFromJsonElement<KBigInt>(encoded)

Serialization strategy

You can use the serializer as the serialization strategy parameter.

import io.github.observeroftime.kbigint.KBigInt
import io.github.observeroftime.kbigint.serialization.KBigIntSerializer
import kotlinx.serialization.json.*

val number = KBigInt("9007199254740991")
val encoded = Json.encodeToJsonElement(KBigIntSerializer, number)
val decoded = Json.decodeFromJsonElement(KBigIntSerializer, encoded)

Packages

io.github.observeroftime.kbigint.serialization

common