Implements Binary Canonical Serialization as an encoding format, enabling serialization and deserialization of basic and user-defined types, with compatibility considerations for Rust developers.
Kotlin Multiplatform implementation of Binary Canonical Serialization (BCS) as an encoding format for the kotlinx.serialization library
Add the kotlinx-serialization-bcs dependency to the common sourceSet
implementation("xyz.mcxross.bcs:bcs:<$bcs_version>")
Add the kotlinx-serialization-bcs dependency to the Project's dependency block
Generic:
implementation("xyz.mcxross.bcs:<bcs-[platform]>:<$bcs_version>")
For example for Android and JS
Android:
implementation("xyz.mcxross.bcs:bcs-android:<$bcs_version>")
JS:
implementation("xyz.mcxross.bcs:bcs-js:<$bcs_version>")
For basic types, simply call the Bcs.encodeToByteArray() function with the desired value, and in each case, you will get a ByteArray containing the state of this object in the BCS format
val bcs = Bcs.encodeToByteArray(Triple(listOf(), "çå∞≠¢õß∂ƒ∫", Location(x = 3, y = 4)))
val bcs = Bcs.encodeToByteArray("çå∞≠¢õß∂ƒ∫")
val bcs = Bcs.encodeToByteArray(listOf(1, 2, 3, 4, 5))
val bcs = Bcs.encodeToByteArray(mapOf("a" to 1, "b" to 2, "c" to 3))
val bcs = Bcs.encodeToByteArray(3.14159265359)
val bcs = Bcs.encodeToByteArray(false)
Deserialization is done by calling the Bcs.decodeFromByteArray() function with the described type
For use-defined types, first make a class serializable by annotating it with @Serializable
@Serializable
data class Data(
val long: Long,
val double: Double,
val string: String,
val boolean: Boolean
)
You can now serialize an instance of this class by calling Bcs.encodeToByteArray()
val bcs = Bcs.encodeToByteArray(
Data(1_000_000, 3.14159265359, "çå∞≠¢õß∂ƒ∫", false)
)
As a result, you get a ByteArray containing the state of this object in the BCS format
To deserialize an object from BCS, use the decodeFromByteArray() function:
val obj = Bcs.decodeFromByteArray<Data>(byteArrayOf())
Note: BCS is not a self-describing format. As such, one must know the message type and layout ahead of time in order to deserialize.
For parity with the original Rust BCS implementation, the following type translations are used:
| Rust type | Kotlin Type |
|---|---|
| Struct | Data class |
| Tuple | Pair, Triple, etc. |
BCS specs can be found here
All contributions to KMP BCS are welcome. Before opening a PR, please submit an issue detailing the bug or feature. When
opening a PR, please ensure that your contribution builds on the KMM toolchain, has been linted
with ktfmt <GOOGLE (INTERNAL)>, and contains tests when applicable. For more information, please see
the contribution guidelines.
Copyright 2022 McXross
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
| Unit |
| Unit |
| Option | T? |
Surfaced from shared tags and platforms — no rankings paid for.