squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #73243 - poliorcetics:discourage-is-file, r=Amanieu

Browse source 
Add documentation to point to `File::open` or `OpenOptions::open` instead of `is_file` to check read/write possibility

Fixes #64170.

This adds documentation to point user towards `!is_dir` instead of `is_file` when all they want to is read from a source.

I ran `rg "fn is_file\("` to find all `is_file` methods, I hope I did not miss one.
This commit is contained in:
Manish Goregaokar 2020-06-27 22:29:52 -07:00 committed by GitHub
commit 6a944c15ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/libstd/fs.rs
View file

@ -1033,8 +1033,16 @@ impl Metadata {
/// [`is_dir`], and will be false for symlink metadata
/// obtained from [`symlink_metadata`].
///
/// When the goal is simply to read from (or write to) the source, the most
/// reliable way to test the source can be read (or written to) is to open
/// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
/// a Unix-like system for example. See [`File::open`] or
/// [`OpenOptions::open`] for more information.
///
/// [`is_dir`]: struct.Metadata.html#method.is_dir
/// [`symlink_metadata`]: fn.symlink_metadata.html
/// [`File::open`]: struct.File.html#method.open
/// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
///
/// # Examples
///
@ -1307,8 +1315,16 @@ impl FileType {
/// [`is_dir`] and [`is_symlink`]; only zero or one of these
/// tests may pass.
///
/// When the goal is simply to read from (or write to) the source, the most
/// reliable way to test the source can be read (or written to) is to open
/// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
/// a Unix-like system for example. See [`File::open`] or
/// [`OpenOptions::open`] for more information.
///
/// [`is_dir`]: struct.FileType.html#method.is_dir
/// [`is_symlink`]: struct.FileType.html#method.is_symlink
/// [`File::open`]: struct.File.html#method.open
/// [`OpenOptions::open`]: struct.OpenOptions.html#method.open
///
/// # Examples
///

17
src/libstd/path.rs
View file

@ -2503,11 +2503,20 @@ 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
/// When the goal is simply to read from (or write to) the source, the most
/// reliable way to test the source can be read (or written to) is to open
/// it. Only using `is_file` can break workflows like `diff <( prog_a )` on
/// a Unix-like system for example. See [`File::open`] or
/// [`OpenOptions::open`] for more information.
///
/// [`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
/// [`File::open`]: ../../std/fs/struct.File.html#method.open
/// [`OpenOptions::open`]: ../../std/fs/struct.OpenOptions.html#method.open
#[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)