diff options
| author | Mazdak Farrokhzad <twingoow@gmail.com> | 2019-09-15 19:35:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-15 19:35:58 +0200 |
| commit | 0a2e07ec1dc5194e12dfb1ca00c4bc87533ac88d (patch) | |
| tree | fc036765ad59c8fd713790a64bf44dcc5f67c18e /src/libstd | |
| parent | 60895fd1f9ad24ee41bb3dac67fc2c5f127ecdb4 (diff) | |
| parent | c8619ae7916459bec1b7e5583d75c69b10f06df9 (diff) | |
| download | rust-0a2e07ec1dc5194e12dfb1ca00c4bc87533ac88d.tar.gz rust-0a2e07ec1dc5194e12dfb1ca00c4bc87533ac88d.zip | |
Rollup merge of #63872 - marmistrz:readdir, r=jonas-schievink
Document platform-specific behavior of the iterator returned by std::fs::read_dir
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/fs.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs index b14e02a2cb4..b5265fe369e 100644 --- a/src/libstd/fs.rs +++ b/src/libstd/fs.rs @@ -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 |