Skip to content

Commit 0a2e07e

Browse files
authored
Rollup merge of rust-lang#63872 - marmistrz:readdir, r=jonas-schievink
Document platform-specific behavior of the iterator returned by std::fs::read_dir
2 parents 60895fd + c8619ae commit 0a2e07e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Diff for: src/libstd/fs.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -1956,7 +1956,8 @@ pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
19561956
/// # Platform-specific behavior
19571957
///
19581958
/// This function currently corresponds to the `opendir` function on Unix
1959-
/// and the `FindFirstFile` function on Windows.
1959+
/// and the `FindFirstFile` function on Windows. Advancing the iterator
1960+
/// currently corresponds to `readdir` on Unix and `FindNextFile` on Windows.
19601961
/// Note that, this [may change in the future][changes].
19611962
///
19621963
/// [changes]: ../io/index.html#platform-specific-behavior

0 commit comments

Comments
 (0)