Struct std::fs::FileType

pub struct FileType(_);

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

fn clone(&self) -> FileType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FileTypeExt for FileType

Available on Unix only.

fn is_block_device(&self) -> bool

Returns true if this file type is a block device.

fn is_char_device(&self) -> bool

Returns true if this file type is a char device.

fn is_fifo(&self) -> bool

Returns true if this file type is a fifo.

fn is_socket(&self) -> bool

Returns true if this file type is a socket.

impl FileTypeExt for FileType

Available on WASI only.

fn is_block_device(&self) -> bool

🔬 This is a nightly-only experimental API. (wasi_ext #71213)

Returns true if this file type is a block device.

fn is_char_device(&self) -> bool

🔬 This is a nightly-only experimental API. (wasi_ext #71213)

Returns true if this file type is a character device.

fn is_socket_dgram(&self) -> bool

🔬 This is a nightly-only experimental API. (wasi_ext #71213)

Returns true if this file type is a socket datagram.

fn is_socket_stream(&self) -> bool

🔬 This is a nightly-only experimental API. (wasi_ext #71213)

Returns true if this file type is a socket stream.

fn is_socket(&self) -> bool

🔬 This is a nightly-only experimental API. (wasi_ext #71213)

Returns true if this file type is any type of socket.

impl FileTypeExt for FileType

Available on Windows only.

fn is_symlink_dir(&self) -> bool

Returns true if this file type is a symbolic link that is also a directory.

fn is_symlink_file(&self) -> bool

Returns true if this file type is a symbolic link that is also a file.

impl Hash for FileType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

fn eq(&self, other: &FileType) -> bool

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

fn ne(&self, other: &FileType) -> bool

This method tests for !=.

impl Copy for FileType

impl Eq for FileType

impl StructuralEq for FileType

impl StructuralPartialEq for FileType