Improve writeCodePointValue KDoc #314
Merged
Conversation
This file contains hidden or 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
shanshin
approved these changes
May 7, 2024
ilya-g
reviewed
May 7, 2024
| @@ -130,6 +130,9 @@ internal fun String.utf8Size(startIndex: Int = 0, endIndex: Int = length): Long | |||
| * Without such a conversion, data written to a [Sink] can not be converted back | |||
| * to a string from which a surrogate pair was retrieved. | |||
| * | |||
| * More specifically, all code points mapping to UTF-16 surrogates (`U+d800`..`U+dfff`) | |||
| * will be written as `?` characters (`U+0063`). | |||
There was a problem hiding this comment.
Is this JVM-only behavior or common one?
There was a problem hiding this comment.
Currently, it's a common one
There was a problem hiding this comment.
This makes it inconsistent with String.encodeToByteArray where the replacement is unspecified, but different.
There was a problem hiding this comment.
encodeToByteArray call on a string with a low surrogate only results in a byte array containing ?: https://pl.kotl.in/uFX3YULin
ilya-g
reviewed
May 7, 2024
| @@ -130,6 +130,9 @@ internal fun String.utf8Size(startIndex: Int = 0, endIndex: Int = length): Long | |||
| * Without such a conversion, data written to a [Sink] can not be converted back | |||
| * to a string from which a surrogate pair was retrieved. | |||
| * | |||
| * More specifically, all code points mapping to UTF-16 surrogates (`U+d800`..`U+dfff`) | |||
| * will be written as `?` characters (`U+0063`). | |||
| * | |||
| * @param codePoint the codePoint to be written. | |||
| * | |||
| * @throws IllegalStateException when the sink is closed. | |||
There was a problem hiding this comment.
Makes sense to document that IllegalArgumentException can be thrown.
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.
Follow up to #308