From f0bfbd3e7201c59b5e155298fc4bdd0acece8992 Mon Sep 17 00:00:00 2001 From: Denis Vasilik Date: Sun, 11 Nov 2018 15:08:28 +0100 Subject: [PATCH] Added comments for trait implementations. --- src/liballoc/string.rs | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/src/liballoc/string.rs b/src/liballoc/string.rs index 50d2c04657a..27a14bd6b8c 100644 --- a/src/liballoc/string.rs +++ b/src/liballoc/string.rs @@ -2207,7 +2207,7 @@ fn from(s: &'a str) -> String { #[stable(feature = "string_from_box", since = "1.18.0")] impl From> for String { /// Converts the given boxed `str` slice to a `String`. - /// It is notable that the `str` slice must be owned. + /// It is notable that the `str` slice is owned. /// /// # Examples /// @@ -2227,6 +2227,19 @@ fn from(s: Box) -> String { #[stable(feature = "box_from_str", since = "1.20.0")] impl From for Box { + /// Converts the given `String` to a boxed `str` slice that is owned. + /// + /// # Examples + /// + /// Basic usage: + /// + /// ``` + /// let s1 = String::from("hello world"); + /// let s2 : Box = Box::from(s1); + /// let s3 : String = String::from(s2); + /// + /// assert_eq!("hello world", s3) + /// ``` fn from(s: String) -> Box { s.into_boxed_str() } @@ -2286,6 +2299,20 @@ fn from_iter>(it: I) -> Cow<'a, str> { #[stable(feature = "from_string_for_vec_u8", since = "1.14.0")] impl From for Vec { + /// Converts the given `String` to a vector `Vec` that holds values of type `u8`. + /// + /// # Examples + /// + /// Basic usage: + /// + /// ``` + /// let s1 = String::from("hello world"); + /// let v1 = Vec::from(s1); + /// + /// for b in v1 { + /// println!("{}", b); + /// } + /// ``` fn from(string: String) -> Vec { string.into_bytes() }