bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add documentation to point to !is_dir instead of is_file

Browse source
This commit is contained in:
Alexis Bourget 2020-06-11 17:44:33 +02:00
parent 50c0192c64
commit 93cbad6ed5
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/libstd/fs.rs
View file

@ -1307,6 +1307,12 @@ impl FileType {
/// [`is_dir`] and [`is_symlink`]; only zero or one of these /// [`is_dir`] and [`is_symlink`]; only zero or one of these
/// tests may pass. /// tests may pass.
/// ///
/// This property means it is often more useful to use `!file_type.is_dir()`
/// than `file_type.is_file()` when your goal is to read bytes from a
/// source: the former includes symlink and pipes when the latter does not,
/// meaning you will break workflows like `diff <( prog_a ) <( prog_b )` on
/// a Unix-like system for example.
///
/// [`is_dir`]: struct.FileType.html#method.is_dir /// [`is_dir`]: struct.FileType.html#method.is_dir
/// [`is_symlink`]: struct.FileType.html#method.is_symlink /// [`is_symlink`]: struct.FileType.html#method.is_symlink
/// ///