summaryrefslogtreecommitdiff
path: root/dokka/moduledoc.md
blob: e3c12610b377dd565d8ecf00c95c6dfd62b981f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Module kotlinx-serialization-core
Core serialization API and serializers for standard library classes, and ready to use JSON
format implementation.

# Module kotlinx-serialization-json
Stable and ready to use JSON format implementation, `JsonElement` API to operate with JSON trees and JSON-specific serializers.

# Module kotlinx-serialization-cbor
Concise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).

# Module kotlinx-serialization-hocon
Allows deserialization of `Config` object from popular [lightbend/config](https://github.com/lightbend/config) library 
into Kotlin objects.
You can learn about "Human-Optimized Config Object Notation" or HOCON from library's [readme](https://github.com/lightbend/config#using-hocon-the-json-superset).

# Module kotlinx-serialization-properties
Allows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties.

# Module kotlinx-serialization-protobuf
Protocol buffers serialization format implementation, mostly compliant to [proto2](https://developers.google.com/protocol-buffers/docs/proto) specification.

# Package kotlinx.serialization
Basic core concepts and annotations that set up serialization process.

# Package kotlinx.serialization.builtins
Serializers for standard Kotlin types, like Int, String, List, etc.

# Package kotlinx.serialization.descriptors
Basic concepts of serial description to programmatically describe the serial form for serializers 
in an introspectable manner.

# Package kotlinx.serialization.encoding
Basic concepts of encoding and decoding of serialized data.

# Package kotlinx.serialization.modules
Classes that provides runtime mechanisms for resolving serializers, typically used during polymorphic serialization.

# Package kotlinx.serialization.hocon
HOCON serialization format implementation for converting Kotlin classes from and to [Lightbend config](https://github.com/lightbend/config).

# Package kotlinx.serialization.json
JSON serialization format implementation, JSON tree data structures with builders for them,
and JSON-specific serializers.

# Package kotlinx.serialization.protobuf
Protocol buffers serialization format implementation, mostly compliant to [proto2](https://developers.google.com/protocol-buffers/docs/proto) specification. 

# Package kotlinx.serialization.properties
Properties serialization format implementation that represents the input data as a plain map of properties.

# Package kotlinx.serialization.cbor
Concise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).