Rollup merge of #44521 - rwakulszowa:str_utf16_doc, r=frewsxcv

Add an example of std::str::encode_utf16

Closes #44419
This commit is contained in:
Corey Farwell 2017-09-14 22:32:45 -04:00 committed by GitHub
commit 50240f80f1

View File

@ -855,6 +855,19 @@ impl str {
}
/// Returns an iterator of `u16` over the string encoded as UTF-16.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// let text = "Zażółć gęślą jaźń";
///
/// let utf8_len = text.len();
/// let utf16_len = text.encode_utf16().count();
///
/// assert!(utf16_len <= utf8_len);
/// ```
#[stable(feature = "encode_utf16", since = "1.8.0")]
pub fn encode_utf16(&self) -> EncodeUtf16 {
EncodeUtf16 { encoder: Utf16Encoder::new(self[..].chars()) }