-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Document valid values of the char type #93493
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -279,16 +279,44 @@ mod prim_never {} | |
/// | ||
/// The `char` type represents a single character. More specifically, since | ||
/// 'character' isn't a well-defined concept in Unicode, `char` is a '[Unicode | ||
/// scalar value]', which is similar to, but not the same as, a '[Unicode code | ||
/// point]'. | ||
/// | ||
/// [Unicode scalar value]: https://www.unicode.org/glossary/#unicode_scalar_value | ||
/// [Unicode code point]: https://www.unicode.org/glossary/#code_point | ||
/// scalar value]'. | ||
/// | ||
/// This documentation describes a number of methods and trait implementations on the | ||
/// `char` type. For technical reasons, there is additional, separate | ||
/// documentation in [the `std::char` module](char/index.html) as well. | ||
/// | ||
/// # Validity | ||
/// | ||
/// A `char` is a '[Unicode scalar value]', which is any '[Unicode code point]' | ||
/// other than a [surrogate code point]. This has a fixed numerical definition: | ||
/// code points are in the range `'\0'` to `char::MAX` (`'\u{10FFFF}'`), inclusive. | ||
/// Surrogate code points, used by UTF-16, are in the range U+D800 to U+DFFF. | ||
/// | ||
/// No `char` may be constructed, whether as a literal or at runtime, that is not a | ||
/// Unicode scalar value: | ||
/// | ||
/// ```text | ||
/// let forbidden_chars = [ | ||
/// // Each of these is a compiler error | ||
/// '\u{D800}', '\u{DFFF}', '\u{110000}', | ||
/// | ||
/// // Panics; from_u32 returns None. | ||
/// char::from_u32(0xDE01).unwrap(), | ||
/// | ||
/// // Undefined behaviour | ||
/// unsafe { char::from_u32_unchecked(0x110000) }, | ||
/// ]; | ||
/// ``` | ||
/// | ||
/// Unicode is regularly updated. Many USVs are not currently assigned to a | ||
/// character, but may be in the future ("reserved"); some will never be a character | ||
/// ("noncharacters"); and some may be given different meanings by different users | ||
/// ("private use"). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure about the wording of this paragraph. If I didn't know otherwise, I might assume from the context that "reserved", "noncharacters" and "private use" were also currently invalid for |
||
/// | ||
/// [Unicode scalar value]: https://www.unicode.org/glossary/#unicode_scalar_value | ||
/// [Unicode code point]: https://www.unicode.org/glossary/#code_point | ||
/// [surrogate code point]: https://www.unicode.org/glossary/#surrogate_code_point | ||
/// | ||
/// # Representation | ||
/// | ||
/// `char` is always four bytes in size. This is a different representation than | ||
|
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
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.
Uh oh!
There was an error while loading. Please reload this page.