diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2015-03-19 16:53:06 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2015-03-19 18:21:39 -0400 |
| commit | 3e3408de0f73f7df7c8a626c64ff4d704f08353d (patch) | |
| tree | 05519fd96fdefcbbf76bc8d257796d6f7d17494c /src/libstd | |
| parent | 08dd30d9eb685f29b82faae66b5fdb9fc4762a91 (diff) | |
| download | rust-3e3408de0f73f7df7c8a626c64ff4d704f08353d.tar.gz rust-3e3408de0f73f7df7c8a626c64ff4d704f08353d.zip | |
Comment on when ReadDir is Err
Fixes #23426
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/fs/mod.rs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libstd/fs/mod.rs b/src/libstd/fs/mod.rs index ba89b3a0ea6..0aae5992196 100644 --- a/src/libstd/fs/mod.rs +++ b/src/libstd/fs/mod.rs @@ -73,6 +73,11 @@ pub struct Metadata(fs_imp::FileAttr); /// will yield instances of `io::Result<DirEntry>`. Through a `DirEntry` /// information like the entry's path and possibly other metadata can be /// learned. +/// +/// # Failure +/// +/// This `io::Result` will be an `Err` if there's some sort of intermittent +/// IO error during iteration. #[stable(feature = "rust1", since = "1.0.0")] pub struct ReadDir(fs_imp::ReadDir); |