Document platform-specific behavior of the iterator returned by std::fs::read_dir

This commit is contained in:
Marcin Mielniczuk 2019-08-25 00:09:12 +02:00
parent eeba189cfb
commit c8619ae791
No known key found for this signature in database
GPG Key ID: 2CF0CE66660B8CC9

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