Document that fs::read_dir skips . and ..

This commit is contained in:
Timotej Lazar 2021-08-07 10:14:41 +02:00
parent 996ff2e0a0
commit c32e4ba60a
No known key found for this signature in database
GPG Key ID: B6F38793D143456F
1 changed files with 2 additions and 0 deletions

View File

@ -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
///