Clarify that std::fs::rename can move #24993
Conversation
|
r? @aturon (rust_highfive has picked a reviewer for you, use r? to override) |
| @@ -844,6 +844,9 @@ pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> { | |||
|
|
|||
| /// Rename a file or directory to a new name. | |||
| /// | |||
| /// Moving a file or directory is also a rename, in a sense, and so this | |||
| /// function is not limited a single directory. | |||
There was a problem hiding this comment.
Hm, was the issue misread perhaps? This seems somewhat confusing as the main docs say "Rename" and then this says it's also a rename. Perhaps this could mention that it could move many files (as part of renaming a directory), but I think the issue in question was also asking for clarification that moving across filesystem boundaries probably isn't allowed.
There was a problem hiding this comment.
No, talking in IRC, the example I used was the behavior they weren't familiar with.
There was a problem hiding this comment.
Er, to be clear, the issue states:
std::fs::rename is missing the explicit description that you can also move a file outside of the current folder with it, as long as it's on the same file system.
This documentation doesn't indicate anything related to filesystem boundaries though? (there's also still the mentioning "rename" twice issue I'm worried about)
There was a problem hiding this comment.
Yeah, I think there was a filing of an issue, and a discussion at the same time. Shame the IRC stuff is lost, argh. We should mention the FS issue regardless.
Fixes #24816