Struct file_system::FileType

[+] Show declaration

pub struct FileType(FileType);

[−] Expand description

A structure representing a type of file with accessors for each file type. It is returned by Metadata::file_type method.

Implementations

impl FileType[−]

pub fn is_dir(&self) -> bool[−]

Tests whether this file type represents a directory. The result is mutually exclusive to the results of is_file and is_symlink; only zero or one of these tests may pass.

Examples

fn main() -> std::io::Result<()> {
    use std::fs;

    let metadata = fs::metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_dir(), false);
    Ok(())
}

pub fn is_file(&self) -> bool[−]

Tests whether this file type represents a regular file. The result is mutually exclusive to the results of 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.

Examples

fn main() -> std::io::Result<()> {
    use std::fs;

    let metadata = fs::metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_file(), true);
    Ok(())
}

pub fn is_symlink(&self) -> bool[−]

Tests whether this file type represents a symbolic link. The result is mutually exclusive to the results of is_dir and is_file; only zero or one of these tests may pass.

The underlying Metadata struct needs to be retrieved with the fs::symlink_metadata function and not the fs::metadata function. The fs::metadata function follows symbolic links, so is_symlink would always return false for the target file.

Examples

use std::fs;

fn main() -> std::io::Result<()> {
    let metadata = fs::symlink_metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_symlink(), false);
    Ok(())
}

Trait Implementations

impl Clone for FileType[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> FileType[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for FileType

impl Debug for FileType[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Eq for FileType

impl FileTypeExt for FileType[+]

[+] Show hidden undocumented items

pub fn is_block_device(&self) -> bool[−]

Returns true if this file type is a block device.

pub fn is_char_device(&self) -> bool[−]

Returns true if this file type is a char device.

pub fn is_fifo(&self) -> bool[−]

Returns true if this file type is a fifo.

pub fn is_socket(&self) -> bool[−]

Returns true if this file type is a socket.

impl Hash for FileType[+]

[+] Show hidden undocumented items

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl PartialEq<FileType> for FileType[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &FileType) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &FileType) -> bool[−]

This method tests for !=.

impl StructuralEq for FileType

impl StructuralPartialEq for FileType