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

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

View file

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