Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 6.71 KB

README.md

File metadata and controls

169 lines (113 loc) · 6.71 KB
Raw

Serialization formats

This area of repository contains different libraries with various add-on formats which were not included in the core library.

For convenience, they have same groupId, versioning and release cycle as core library.

JSON

  • Artifact id: kotlinx-serialization-json
  • Platform: all supported platforms
  • Status: stable

HOCON

  • Artifact id: kotlinx-serialization-hocon
  • Platform: JVM only
  • Status: experimental

Allows deserialization of Config object from popular lightbend/config library into Kotlin objects. You can learn about "Human-Optimized Config Object Notation" or HOCON from library's readme.

ProtoBuf

  • Artifact id: kotlinx-serialization-protobuf
  • Platform: all supported platforms
  • Status: experimental

CBOR

  • Artifact id: kotlinx-serialization-cbor
  • Platform: all supported platforms
  • Status: experimental

Properties

  • Artifact id: kotlinx-serialization-properties
  • Platform: all supported platforms
  • Status: experimental

Allows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties.

Other community-supported formats

Avro

  • GitHub repo: sksamuel/avro4k
  • Artifact ID: com.sksamuel.avro4k:avro4k
  • Platform: JVM only

This library allows serialization and deserialization of objects to and from Avro. It will read and write from Avro binary or json streams or generate Avro Generic Records directly. It will also generate Avro schemas from data classes. The library allows for easy extension and overrides for custom schema formats, compatiblity with schemas defined outside out of the JVM and for types not supported out of the box.

Bson

  • GitHub repo: jershell/kbson
  • Artifact ID: com.github.jershell:kbson
  • Platform: JVM only

Allows serialization and deserialization of objects to and from BSON.

Ktoml

  • GitHub repo: akuleshov7/ktoml
  • Artifact ID: com.akuleshov7:ktoml-core
  • Platforms: multiplatform, all Kotlin supported platforms

Fully Native and Multiplatform Kotlin serialization library for serialization/deserialization of TOML format. This library contains no Java code and no Java dependencies and it implements multiplatform parser, decoder and encoder of TOML.

Minecraft NBT (Multiplatform)

  • GitHub repo: BenWoodworth/knbt
  • Artifact ID: net.benwoodworth.knbt:knbt
  • Platform: all supported platforms

Implements the NBT format for kotlinx.serialization, and provides a type-safe DSL for constructing NBT tags.

MsgPack (Multiplatform)

Allows serialization and deserialization of objects to and from MsgPack.

SharedPreferences

This library allows serialization and deserialization of objects into and from Android SharedPreferences.

XML

  • GitHub repo: pdvrieze/xmlutil
  • Artifact ID: io.github.pdvrieze.xmlutil:serialization
  • Platform: all supported platforms

This library allows for reading and writing of XML documents with the serialization library. It is multiplatform, providing both a shared parser/writer for xml as well as platform-specific parsers where available. The library is designed to handle existing xml formats that use features that would not be available in other formats such as JSON.

YAML

  • GitHub repo: charleskorn/kaml
  • Artifact ID: com.charleskorn.kaml:kaml
  • Platform: JVM only

Allows serialization and deserialization of objects to and from YAML.

YAML (Multiplatform)

  • GitHub repo: him188/yamlkt
  • Artifact ID: net.mamoe.yamlkt:yamlkt
  • Platform: all supported platforms

Allows serialization and deserialization of objects to and from YAML. Basic serial operations have been implemented, but some features such as compound keys and polymorphism are still work in progress.

CBOR

  • GitHub repo: L-Briand/obor
  • Artifact ID: net.orandja.obor:obor
  • Platform: JVM, Android

Allow serialization and deserialization of objects to and from CBOR. This codec can be used to read and write from Java InputStream and OutputStream.

Amazon Ion (binary only)

Allow serialization and deserialization of objects to and from Amazon Ion. It stores the data in a flat binary format. Upon destialization, it retains the references between the objects.

android.os.Bundle

Allow serialization and deserialization of objects to and from android.os.Bundle.

CSV

Allows serialization and deserialization of CSV files. There are still some limitations (ordered properties).

Fixed Length Format

Allows serialization and deserialization of Fixed Length Format files. Each property must be annotated with @FixedLength and there are still some limitations due to missing delimiters.

JSON5

  • GitHub repo: xn32/json5k
  • Artifact ID: io.github.xn32:json5k
  • Platform: JVM only

Library for the serialization to and deserialization from JSON5 text.