bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Make a note about is_dir vs is_file in Path too

Browse source
This commit is contained in:
Alexis Bourget 2020-06-11 18:17:00 +02:00
parent ec63f9d99b
commit c1243dbcd9
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/libstd/path.rs
View file

@ -2503,11 +2503,15 @@ impl Path {
/// # See Also
///
/// This is a convenience function that coerces errors to false. If you want to
/// check errors, call [fs::metadata] and handle its Result. Then call
/// [fs::Metadata::is_file] if it was Ok.
/// check errors, call [`fs::metadata`] and handle its Result. Then call
/// [`fs::Metadata::is_file`] if it was Ok.
///
/// [fs::metadata]: ../../std/fs/fn.metadata.html
/// [fs::Metadata::is_file]: ../../std/fs/struct.Metadata.html#method.is_file
/// Note that the explanation about using `!is_dir` instead of `is_file`
/// that is present in the [`fs::Metadata`] documentation also applies here.
///
/// [`fs::metadata`]: ../../std/fs/fn.metadata.html
/// [`fs::Metadata`]: ../../std/fs/struct.Metadata.html
/// [`fs::Metadata::is_file`]: ../../std/fs/struct.Metadata.html#method.is_file
#[stable(feature = "path_ext", since = "1.5.0")]
pub fn is_file(&self) -> bool {
fs::metadata(self).map(|m| m.is_file()).unwrap_or(false)