update: first update for serialization documentation restructuring #2978
Conversation
There was a problem hiding this comment.
Calling the middle step Primitives is misleading (as this is not Kotlin/Java primitive types). Instead the middle steps are actually serialization library calls (with a given set, including primitive types, but also supporting structures and "special" types).
There was a problem hiding this comment.
Hey @pdvrieze - thank you for your comments 💯 - we are still in the review process for these updates (just a draft PR at this point), but we will take a look at your feedback during the review
| 1. Serialization: Objects are transformed into a sequence of their primitive values. | ||
| This universal process varies depending on the object and is managed by a serializer. |
There was a problem hiding this comment.
This is misleading. Serialization translates objects to a sequence of encoder calls. There is no intermediate format, and such a format would not actually work (many formats allow for "special casing").
| The reverse process involves parsing the input format, decoding the primitive values, and then deserializing the resulting | ||
| stream into objects. |
There was a problem hiding this comment.
The reverse process involves the decoder invoking the input format to guide it in parsing the input (there is no intermediate format and that cannot exist - note that formats may not allow parsing without the knowledge of specific data structures (generally non-self-describing binary formats)).
|
|
||
| ## Kotlin serialization libraries | ||
|
|
||
| The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. |
There was a problem hiding this comment.
It may be worthwhile to clarify more that the serialization library provides the format agnostic infrastructure. Then the -json and -cbor libraries are format implementations (they are fundamentally different and are independent even though first-party).
This PR is for the first batch of documentation updates for KT-66330
Additional PRs will be opened on this one.