xref: /aosp_15_r20/external/kotlinx.serialization/dokka/moduledoc.md (revision 57b5a4a64c534cf7f27ac9427ceab07f3d8ed3d8)
1*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-core
2*57b5a4a6SAndroid Build Coastguard WorkerCore serialization API and serializers for standard library classes, and ready to use JSON
3*57b5a4a6SAndroid Build Coastguard Workerformat implementation.
4*57b5a4a6SAndroid Build Coastguard Worker
5*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-json
6*57b5a4a6SAndroid Build Coastguard WorkerStable and ready to use JSON format implementation, `JsonElement` API to operate with JSON trees and JSON-specific serializers.
7*57b5a4a6SAndroid Build Coastguard Worker
8*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-json-okio
9*57b5a4a6SAndroid Build Coastguard WorkerExtensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
10*57b5a4a6SAndroid Build Coastguard WorkerCurrently experimental.
11*57b5a4a6SAndroid Build Coastguard Worker
12*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-cbor
13*57b5a4a6SAndroid Build Coastguard WorkerConcise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).
14*57b5a4a6SAndroid Build Coastguard Worker
15*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-hocon
16*57b5a4a6SAndroid Build Coastguard WorkerAllows deserialization of `Config` object from popular [lightbend/config](https://github.com/lightbend/config) library
17*57b5a4a6SAndroid Build Coastguard Workerinto Kotlin objects.
18*57b5a4a6SAndroid Build Coastguard WorkerYou 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*57b5a4a6SAndroid Build Coastguard Worker
20*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-properties
21*57b5a4a6SAndroid Build Coastguard WorkerAllows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties.
22*57b5a4a6SAndroid Build Coastguard Worker
23*57b5a4a6SAndroid Build Coastguard Worker# Module kotlinx-serialization-protobuf
24*57b5a4a6SAndroid Build Coastguard Worker[Protocol buffers](https://protobuf.dev/) serialization format implementation.
25*57b5a4a6SAndroid Build Coastguard Worker
26*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization
27*57b5a4a6SAndroid Build Coastguard WorkerBasic core concepts and annotations that set up serialization process.
28*57b5a4a6SAndroid Build Coastguard Worker
29*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.builtins
30*57b5a4a6SAndroid Build Coastguard WorkerSerializers for standard Kotlin types, like Int, String, List, etc.
31*57b5a4a6SAndroid Build Coastguard Worker
32*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.descriptors
33*57b5a4a6SAndroid Build Coastguard WorkerBasic concepts of serial description to programmatically describe the serial form for serializers
34*57b5a4a6SAndroid Build Coastguard Workerin an introspectable manner.
35*57b5a4a6SAndroid Build Coastguard Worker
36*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.encoding
37*57b5a4a6SAndroid Build Coastguard WorkerBasic concepts of encoding and decoding of serialized data.
38*57b5a4a6SAndroid Build Coastguard Worker
39*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.modules
40*57b5a4a6SAndroid Build Coastguard WorkerClasses that provides runtime mechanisms for resolving serializers, typically used during polymorphic serialization.
41*57b5a4a6SAndroid Build Coastguard Worker
42*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.hocon
43*57b5a4a6SAndroid Build Coastguard WorkerHOCON serialization format implementation for converting Kotlin classes from and to [Lightbend config](https://github.com/lightbend/config).
44*57b5a4a6SAndroid Build Coastguard Worker
45*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.json
46*57b5a4a6SAndroid Build Coastguard WorkerJSON serialization format implementation, JSON tree data structures with builders for them,
47*57b5a4a6SAndroid Build Coastguard Workerand JSON-specific serializers.
48*57b5a4a6SAndroid Build Coastguard Worker
49*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.json.okio
50*57b5a4a6SAndroid Build Coastguard WorkerExtensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
51*57b5a4a6SAndroid Build Coastguard Worker
52*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.protobuf
53*57b5a4a6SAndroid Build Coastguard Worker[Protocol buffers](https://protobuf.dev/) serialization format implementation.
54*57b5a4a6SAndroid Build Coastguard Worker
55*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.protobuf.schema
56*57b5a4a6SAndroid Build Coastguard WorkerExperimental generator of ProtoBuf schema from Kotlin classes.
57*57b5a4a6SAndroid Build Coastguard Worker
58*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.properties
59*57b5a4a6SAndroid Build Coastguard WorkerProperties serialization format implementation that represents the input data as a plain map of properties.
60*57b5a4a6SAndroid Build Coastguard Worker
61*57b5a4a6SAndroid Build Coastguard Worker# Package kotlinx.serialization.cbor
62*57b5a4a6SAndroid Build Coastguard WorkerConcise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).
63