Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Comment on when ReadDir is Err
Fixes #23426
  • Loading branch information
steveklabnik committed Mar 19, 2015
1 parent 08dd30d commit 3e3408d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/libstd/fs/mod.rs
Expand Up @@ -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);

Expand Down

0 comments on commit 3e3408d

Please sign in to comment.