about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJoão M. Bezerra <marcospb19@hotmail.com>2023-03-23 17:29:55 -0300
committerJoão M. Bezerra <marcospb19@hotmail.com>2023-04-14 18:06:20 -0300
commit4eb4e1022a3e8fd03fda44b40e270bd94cb9c476 (patch)
tree4b8ee237c204ba16dae3fcba826a10bed76fea1f
parentdf7fd9995f10627f25ccb325f693a11b3395a73c (diff)
downloadrust-4eb4e1022a3e8fd03fda44b40e270bd94cb9c476.tar.gz
rust-4eb4e1022a3e8fd03fda44b40e270bd94cb9c476.zip
edit docs of `PathBuf::set_file_name`
to show this method might replace or remove the extension, not just the
file stem

also edit docs of `Path::with_file_name` because it calls
`PathBuf::set_file_name`
-rw-r--r--library/std/src/path.rs16
1 files changed, 11 insertions, 5 deletions
diff --git a/library/std/src/path.rs b/library/std/src/path.rs
index dbc18f7827e..f3608187cce 100644
--- a/library/std/src/path.rs
+++ b/library/std/src/path.rs
@@ -1395,11 +1395,16 @@ impl PathBuf {
     ///
     /// let mut buf = PathBuf::from("/");
     /// assert!(buf.file_name() == None);
-    /// buf.set_file_name("bar");
-    /// assert!(buf == PathBuf::from("/bar"));
+    ///
+    /// buf.set_file_name("foo.txt");
+    /// assert!(buf == PathBuf::from("/foo.txt"));
     /// assert!(buf.file_name().is_some());
-    /// buf.set_file_name("baz.txt");
-    /// assert!(buf == PathBuf::from("/baz.txt"));
+    ///
+    /// buf.set_file_name("bar.txt");
+    /// assert!(buf == PathBuf::from("/bar.txt"));
+    ///
+    /// buf.set_file_name("baz");
+    /// assert!(buf == PathBuf::from("/baz"));
     /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S) {
@@ -2562,7 +2567,8 @@ impl Path {
     /// ```
     /// use std::path::{Path, PathBuf};
     ///
-    /// let path = Path::new("/tmp/foo.txt");
+    /// let path = Path::new("/tmp/foo.png");
+    /// assert_eq!(path.with_file_name("bar"), PathBuf::from("/tmp/bar"));
     /// assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));
     ///
     /// let path = Path::new("/tmp");