diff --git a/library/alloc/src/string.rs b/library/alloc/src/string.rs index 983376a282be5..c19a977236582 100644 --- a/library/alloc/src/string.rs +++ b/library/alloc/src/string.rs @@ -69,7 +69,7 @@ use crate::boxed::Box; use crate::collections::TryReserveError; use crate::str::{self, Chars, Utf8Error}; #[cfg(not(no_global_oom_handling))] -use crate::str::{from_boxed_utf8_unchecked, FromStr}; +use crate::str::{from_boxed_utf8_unchecked, from_utf8_unchecked_mut, FromStr}; use crate::vec::Vec; /// A UTF-8–encoded, growable string. @@ -1849,6 +1849,35 @@ impl String { let slice = self.vec.into_boxed_slice(); unsafe { from_boxed_utf8_unchecked(slice) } } + + /// Consumes and leaks the `String`, returning a mutable reference to the contents, + /// `&'a mut str`. + /// + /// This is mainly useful for data that lives for the remainder of + /// the program's life. Dropping the returned reference will cause a memory + /// leak. + /// + /// It does not reallocate or shrink the `String`, + /// so the leaked allocation may include unused capacity that is not part + /// of the returned slice. + /// + /// # Examples + /// + /// Simple usage: + /// + /// ``` + /// #![feature(string_leak)] + /// + /// let x = String::from("bucket"); + /// let static_ref: &'static mut str = x.leak(); + /// assert_eq!(static_ref, "bucket"); + /// ``` + #[unstable(feature = "string_leak", issue = "102929")] + #[inline] + pub fn leak(self) -> &'static mut str { + let slice = self.vec.leak(); + unsafe { from_utf8_unchecked_mut(slice) } + } } impl FromUtf8Error {