Clarify behavior of strings with invalid UTF-8 byte sequences #13314
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
Sija
reviewed
Apr 13, 2023
| @@ -5254,11 +5261,17 @@ class String | |||
| # Returns the underlying bytes of this String. | |||
| # | |||
| # The returned slice is read-only. | |||
| # | |||
| # May contain invalid UTF-8 byte sequences; `#scrub` may be used to first | |||
There was a problem hiding this comment.
I'd suggest being more explicit.
Suggested change
| # May contain invalid UTF-8 byte sequences; `#scrub` may be used to first | |
| # WARNING: May contain invalid UTF-8 byte sequences; `#scrub` may be used to first |
| def to_slice : Bytes | ||
| Slice.new(to_unsafe, bytesize, read_only: true) | ||
| end | ||
|
|
||
| # Returns a pointer to the underlying bytes of this String. | ||
| # | ||
| # May contain invalid UTF-8 byte sequences; `#scrub` may be used to first |
straight-shoota
approved these changes
Apr 13, 2023
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.
Includes a blanket statement that
Regexmight not likeStrings with invalid UTF-8 byte sequences (not just PCRE and PCRE2, but also any future replacement if the day ever comes), and encourages people to use#scrubif applicable.