xref: /aosp_15_r20/external/kotlinx.serialization/dokka/moduledoc.md (revision 57b5a4a64c534cf7f27ac9427ceab07f3d8ed3d8)
1# Module kotlinx-serialization-core
2Core serialization API and serializers for standard library classes, and ready to use JSON
3format implementation.
4
5# Module kotlinx-serialization-json
6Stable and ready to use JSON format implementation, `JsonElement` API to operate with JSON trees and JSON-specific serializers.
7
8# Module kotlinx-serialization-json-okio
9Extensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
10Currently experimental.
11
12# Module kotlinx-serialization-cbor
13Concise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).
14
15# Module kotlinx-serialization-hocon
16Allows deserialization of `Config` object from popular [lightbend/config](https://github.com/lightbend/config) library
17into Kotlin objects.
18You can learn about "Human-Optimized Config Object Notation" or HOCON from library's [readme](https://github.com/lightbend/config#using-hocon-the-json-superset).
19
20# Module kotlinx-serialization-properties
21Allows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties.
22
23# Module kotlinx-serialization-protobuf
24[Protocol buffers](https://protobuf.dev/) serialization format implementation.
25
26# Package kotlinx.serialization
27Basic core concepts and annotations that set up serialization process.
28
29# Package kotlinx.serialization.builtins
30Serializers for standard Kotlin types, like Int, String, List, etc.
31
32# Package kotlinx.serialization.descriptors
33Basic concepts of serial description to programmatically describe the serial form for serializers
34in an introspectable manner.
35
36# Package kotlinx.serialization.encoding
37Basic concepts of encoding and decoding of serialized data.
38
39# Package kotlinx.serialization.modules
40Classes that provides runtime mechanisms for resolving serializers, typically used during polymorphic serialization.
41
42# Package kotlinx.serialization.hocon
43HOCON serialization format implementation for converting Kotlin classes from and to [Lightbend config](https://github.com/lightbend/config).
44
45# Package kotlinx.serialization.json
46JSON serialization format implementation, JSON tree data structures with builders for them,
47and JSON-specific serializers.
48
49# Package kotlinx.serialization.json.okio
50Extensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
51
52# Package kotlinx.serialization.protobuf
53[Protocol buffers](https://protobuf.dev/) serialization format implementation.
54
55# Package kotlinx.serialization.protobuf.schema
56Experimental generator of ProtoBuf schema from Kotlin classes.
57
58# Package kotlinx.serialization.properties
59Properties serialization format implementation that represents the input data as a plain map of properties.
60
61# Package kotlinx.serialization.cbor
62Concise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).
63