mirror of https://github.com/rust-lang/rust.git
Rollup merge of #87838 - jetomit:add-readdir-note, r=dtolnay
Document that fs::read_dir skips . and .. Hi, I think this is worth noting in the docs since it differs from POSIX `readdir`. I didn’t put it under platform-specific notes because it seems to be consistent across platforms, and changing this behavior in the future could cause pretty nasty bugs. Thanks!
This commit is contained in:
commit
349290047f
|
@ -2039,6 +2039,8 @@ pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
|
|||
///
|
||||
/// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`.
|
||||
/// New errors may be encountered after an iterator is initially constructed.
|
||||
/// Entries for the current and parent directories (typically `.` and `..`) are
|
||||
/// skipped.
|
||||
///
|
||||
/// # Platform-specific behavior
|
||||
///
|
||||
|
|
Loading…
Reference in New Issue