about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndres Suarez <zertosh@gmail.com>2022-11-28 02:40:38 +0000
committerAndres Suarez <zertosh@gmail.com>2022-11-28 12:06:59 -0500
commit9d66ab0f9dea6d8203ceeb29e7da0fd48945ddb7 (patch)
tree62c246432f50dae5e917da360ea7fa9fe40438be
parent8a09420ac48658cad726e0a6997687ceac4151e3 (diff)
downloadrust-9d66ab0f9dea6d8203ceeb29e7da0fd48945ddb7.tar.gz
rust-9d66ab0f9dea6d8203ceeb29e7da0fd48945ddb7.zip
Add `as_mut_os_string` to `&mut PathBuf` and `as_mut_os_str` to `&mut Path`
Implements rust-lang/libs-team#140
-rw-r--r--library/std/src/path.rs46
1 files changed, 46 insertions, 0 deletions
diff --git a/library/std/src/path.rs b/library/std/src/path.rs
index af88b9070c1..6c957c2fa90 100644
--- a/library/std/src/path.rs
+++ b/library/std/src/path.rs
@@ -1463,6 +1463,30 @@ impl PathBuf {
         true
     }
 
+    /// Yields a mutable reference to the underlying [`OsString`] instance.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// #![feature(path_as_mut_os_str)]
+    /// use std::path::{Path, PathBuf};
+    ///
+    /// let mut path = PathBuf::from("/foo");
+    ///
+    /// path.push("bar");
+    /// assert_eq!(path, Path::new("/foo/bar"));
+    ///
+    /// // OsString's `push` does not add a separator.
+    /// path.as_mut_os_string().push("baz");
+    /// assert_eq!(path, Path::new("/foo/barbaz"));
+    /// ```
+    #[unstable(feature = "path_as_mut_os_str", issue = "105021")]
+    #[must_use]
+    #[inline]
+    pub fn as_mut_os_string(&mut self) -> &mut OsString {
+        &mut self.inner
+    }
+
     /// Consumes the `PathBuf`, yielding its internal [`OsString`] storage.
     ///
     /// # Examples
@@ -1993,6 +2017,28 @@ impl Path {
         &self.inner
     }
 
+    /// Yields a mutable reference to the underlying [`OsStr`] slice.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// #![feature(path_as_mut_os_str)]
+    /// use std::path::{Path, PathBuf};
+    ///
+    /// let mut path = PathBuf::from("/Foo.TXT").into_boxed_path();
+    ///
+    /// assert_ne!(&*path, Path::new("/foo.txt"));
+    ///
+    /// path.as_mut_os_str().make_ascii_lowercase();
+    /// assert_eq!(&*path, Path::new("/foo.txt"));
+    /// ```
+    #[unstable(feature = "path_as_mut_os_str", issue = "105021")]
+    #[must_use]
+    #[inline]
+    pub fn as_mut_os_str(&mut self) -> &mut OsStr {
+        &mut self.inner
+    }
+
     /// Yields a [`&str`] slice if the `Path` is valid unicode.
     ///
     /// This conversion may entail doing a check for UTF-8 validity.