Enum file_type_enum::FileType

pub enum FileType {
    Regular,
    Directory,
    Symlink,
    BlockDevice,
    CharDevice,
    Fifo,
    Socket,
}

An enum with a variant for each file type.

match file_type {
    FileType::Regular     => { /* ... */ },
    FileType::Directory   => { /* ... */ },
    FileType::Symlink     => { /* ... */ },
    FileType::BlockDevice => { /* ... */ },
    FileType::CharDevice  => { /* ... */ },
    FileType::Fifo        => { /* ... */ },
    FileType::Socket      => { /* ... */ },
}

Variants

Regular

Directory

Symlink

BlockDevice

CharDevice

Fifo

Socket

Implementations

impl FileType

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Try to get FileType from a path.

This function follows symlinks, so it can never return a FileType::Symlink.

Example:

use file_type_enum::FileType;
use std::io;

fn main() -> io::Result<()> {
    let is_everything_alright = FileType::from_path("/dev/tty")?.is_char_device();
    Ok(())
}

Errors:

• Path does not exist.
• The user lacks permissions to run fs::metadata(path).

pub fn from_symlink_path(path: impl AsRef<Path>) -> Result<Self>

Try to get FileType from a path.

Don't follow symlinks, so the result can be the variant FileType::Symlink too.

Example:

use file_type_enum::FileType;

let path = "/dev/stdout";
let file_type = FileType::from_symlink_path(path).unwrap();

println!("There's a {} at {}!", file_type, path);
// Outputs: "There's a symlink at /dev/stdout!"

Errors:

• Path does not exist.
• The user lacks permissions to run fs::symlink_metadata(path).

pub fn is_regular(&self) -> bool

pub fn is_directory(&self) -> bool

pub fn is_symlink(&self) -> bool

pub fn is_block_device(&self) -> bool

pub fn is_char_device(&self) -> bool

pub fn is_fifo(&self) -> bool

pub fn is_socket(&self) -> bool

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 Copy for FileType

impl Debug for FileType

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

Formats the value using the given formatter.

impl Display for FileType

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

Formats the value using the given formatter.

impl Eq for FileType

impl From<FileType> for FileType

fn from(ft: FileType) -> Self

Performs the conversion.

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 Ord for FileType

fn cmp(&self, other: &FileType) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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 ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<FileType> for FileType

fn partial_cmp(&self, other: &FileType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for FileType

impl StructuralPartialEq for FileType