Skip to content

Commit

Permalink
Rollup merge of rust-lang#87838 - jetomit:add-readdir-note, r=dtolnay
Browse files Browse the repository at this point in the history
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!
  • Loading branch information
JohnTitor authored Aug 7, 2021
2 parents 461c677 + c32e4ba commit c0c0a4d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions library/std/src/fs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit c0c0a4d

Please sign in to comment.