nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-02-11 22:43:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #103102 - H4x5:len_utf16_docs, r=scottmcm

Browse Source 
Clarify the possible return values of `len_utf16`

`char::len_utf16` always return 1 or 2. Clarify this in the docs, in the same way as `char::len_utf8`.
This commit is contained in:
Matthias Krüger 2022-10-16 22:36:06 +02:00 committed by GitHub
commit bdfc262742
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
library/core/src/char/methods.rs
View File

@ -597,9 +597,14 @@ impl char {
/// Returns the number of 16-bit code units this `char` would need if
/// encoded in UTF-16.
///
/// That number of code units is always either 1 or 2, for unicode scalar values in
/// the [basic multilingual plane] or [supplementary planes] respectively.
///
/// See the documentation for [`len_utf8()`] for more explanation of this
/// concept. This function is a mirror, but for UTF-16 instead of UTF-8.
///
/// [basic multilingual plane]: http://www.unicode.org/glossary/#basic_multilingual_plane
/// [supplementary planes]: http://www.unicode.org/glossary/#supplementary_planes
/// [`len_utf8()`]: #method.len_utf8
///
/// # Examples