1
Fork 0

Rollup merge of #44497 - tommyip:doc_example, r=frewsxcv

Add doc example to str::from_boxed_utf8_unchecked

Fixes #44463.
This commit is contained in:
Corey Farwell 2017-09-14 22:32:44 -04:00 committed by GitHub
commit 1d361ff2a5

View file

@ -2061,6 +2061,17 @@ impl str {
/// Converts a boxed slice of bytes to a boxed string slice without checking
/// that the string contains valid UTF-8.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// let smile_utf8 = Box::new([226, 152, 186]);
/// let smile = unsafe { std::str::from_boxed_utf8_unchecked(smile_utf8) };
///
/// assert_eq!("☺", &*smile);
/// ```
#[stable(feature = "str_box_extras", since = "1.20.0")]
pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str> {
mem::transmute(v)