Document that fs::read_dir skips . and ..

JohnTitor · Aug 7, 2021 · c32e4ba · c32e4ba
1 parent 996ff2e
commit c32e4ba
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs
@@ -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
 ///