kotlinx-serialization

A runtime library that makes usage of code generated by kotlinx.serialization compiler plugin. Contains core serialization API, as well as serializers for standard library classes, and ready for use JSON format implementation. Other formats implementations (Protobuf, CBOR) are provided by separate artifacts, but included to this document for integrity.

Packages

(common, js, jvm, native)

kotlinx.serialization

Basic core concepts and annotations that set up serialization process.

(common, js, jvm, native)

kotlinx.serialization.builtins

Serializers for standard Kotlin types, like Int, String, List, etc.

(common, js, jvm, native)

kotlinx.serialization.cbor

Concise Binary Object Representation (CBOR) format implementation, as per RFC7049. Located in separate kotlinx-serialization-cbor artifact.

(common, js, jvm, native)

kotlinx.serialization.json

JSON serialization format implementation, JSON syntax tree data structures with builders for them, and JSON-specific serializers.

(common, js, jvm, native)

kotlinx.serialization.modules

Classes that provides runtime mechanisms for resolving serializers, typically used during polymorphic serialization.

(common, js, jvm, native)

kotlinx.serialization.protobuf

Protocol buffers serialization format implementation, mostly complaint to proto2 specification. Located in separate kotlinx-serialization-protobuf artifact.

Index

All Types