Rollup merge of #44572 - frewsxcv:frewsxcv-from-utf16-lossy, r=QuietM…

…isdreavus Clarify return type of `String::from_utf16_lossy`. Fixes #32874
rust-lang · Sep 15, 2017 · 68e0f28 · 68e0f28
2 parents 2a86884 + 258ef37
commit 68e0f28
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/liballoc/string.rs b/src/liballoc/string.rs
@@ -622,6 +622,13 @@ impl String {
     /// Decode a UTF-16 encoded slice `v` into a `String`, replacing
     /// invalid data with the replacement character (U+FFFD).
     ///
+    /// Unlike [`from_utf8_lossy`] which returns a [`Cow<'a, str>`],
+    /// `from_utf16_lossy` returns a `String` since the UTF-16 to UTF-8
+    /// conversion requires a memory allocation.
+    ///
+    /// [`from_utf8_lossy`]: #method.from_utf8_lossy
+    /// [`Cow<'a, str>`]: ../borrow/enum.Cow.html
+    ///
     /// # Examples
     ///
     /// Basic usage: