Introduce @SubclassOptInRequired to codebase and stabilize part of SerialDescriptor's API #2764
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@qwwdfsad, although I'm not sure if we should introduce it now since https://youtrack.jetbrains.com/issue/KTIJ-30831 may lead to a poor UX |
qwwdfsad
force-pushed
the
subclass-optin-required
branch
from
814f5f8
to
abcb8e8
Compare
qwwdfsad
reviewed
Aug 26, 2024
core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptor.kt
Show resolved
Hide resolved
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental. Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
and allow creating primitive descriptors via it as well. This constructor function is a way to create a descriptor for your custom serializer if it simply delegates to an existing one. Since it fits its purpose and is unlikely to change in the future, we can promote it to stable API alongside other descriptor builders. Fixes #2547
to be used with @SubclassOptInRequired. These annotations allow for even more fine-grained API marking. We now can designate APIs as public for use, but closed for implementation (@SealedSerializationApi) — the case for SerialDescriptor, which is a non-sealed interface for technical reasons. The other annotation, @AdvancedEncodingApi is aimed to provide guidance on implementing custom encoders/decoders by pointing users to a documentation and guides. Fixes #2366
sandwwraith
force-pushed
the
subclass-optin-required
branch
from
abcb8e8
to
5d538ee
Compare
qwwdfsad
approved these changes
Aug 29, 2024
There was a problem hiding this comment.
Great job!
One meta-comment: eventually we'll switch to @sample that will be auto-runnable from kotlinlang and from IDE.
For that, you probably may want to change the sample form from
someFoo // computes to "kotlin.somefoo"
to the following
val someFooName = someFoo
print(someFooName) // Prints "kotlin.somefoo"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.