diff options
| author | Marcin Mielniczuk <marmistrz.dev@zoho.eu> | 2019-08-25 00:09:12 +0200 |
|---|---|---|
| committer | Marcin Mielniczuk <marmistrz.dev@zoho.eu> | 2019-08-25 00:09:12 +0200 |
| commit | c8619ae7916459bec1b7e5583d75c69b10f06df9 (patch) | |
| tree | df257e6074671c428d3d3a25976f447bdd26b597 /src/libstd | |
| parent | eeba189cfb2cfc5c5898513352d4ca8f1df06e05 (diff) | |
| download | rust-c8619ae7916459bec1b7e5583d75c69b10f06df9.tar.gz rust-c8619ae7916459bec1b7e5583d75c69b10f06df9.zip | |
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 5f76875bd66..90d911a6f9a 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 |