squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #63872 - marmistrz:readdir, r=jonas-schievink

Browse source 
Document platform-specific behavior of the iterator returned by std::fs::read_dir
This commit is contained in:
Mazdak Farrokhzad 2019-09-15 19:35:58 +02:00 committed by GitHub
commit 0a2e07ec1d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/libstd/fs.rs
View file

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