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