Struct std::fs::FileType1.1.0[][src]

pub struct 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

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(())
}
Run

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(())
}
Run

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(())
}
Run

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This is supported on Unix only.

Returns true if this file type is a block device. Read more

Returns true if this file type is a char device. Read more

Returns true if this file type is a fifo. Read more

Returns true if this file type is a socket. Read more

This is supported on WASI only.
🔬 This is a nightly-only experimental API. (wasi_ext)

Returns true if this file type is a block device.

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

Returns true if this file type is a character device.

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

Returns true if this file type is a socket datagram.

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

Returns true if this file type is a socket stream.

This is supported on Windows only.
🔬 This is a nightly-only experimental API. (windows_file_type_ext)

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

🔬 This is a nightly-only experimental API. (windows_file_type_ext)

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

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.