From bc1a4c635703e08f0ee5830b389b2b804e82d76b Mon Sep 17 00:00:00 2001 From: Tommy Ip Date: Sat, 9 Sep 2017 13:08:26 +0100 Subject: [PATCH] Add doc example to String::as_mut_str Fixes #44429. --- src/liballoc/string.rs | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/liballoc/string.rs b/src/liballoc/string.rs index ddb23b2ef37..9fef66f2c0a 100644 --- a/src/liballoc/string.rs +++ b/src/liballoc/string.rs @@ -749,7 +749,22 @@ pub fn as_str(&self) -> &str { self } - /// Extracts a string slice containing the entire string. + /// Converts a `String` into a mutable string slice. + /// + /// # Examples + /// + /// Basic usage: + /// + /// ``` + /// use std::ascii::AsciiExt; + /// + /// let mut s = String::from("foobar"); + /// let s_mut_str = s.as_mut_str(); + /// + /// s_mut_str.make_ascii_uppercase(); + /// + /// assert_eq!("FOOBAR", s_mut_str); + /// ``` #[inline] #[stable(feature = "string_as_str", since = "1.7.0")] pub fn as_mut_str(&mut self) -> &mut str {