Enum FileType

pub enum FileType {
    BlockDevice,
    CharDevice,
    Directory,
    Pipe,
    Symlink,
    RegularFile,
    Socket,
    Unknown,
}

Represents the type of a file in the filesystem, tiny enum

Variants

BlockDevice

CharDevice

Directory

Pipe

Symlink

RegularFile

Socket

Unknown

Implementations

impl FileType

pub const fn from_dtype(d_type: u8) -> Self

Converts a libc file type to a FileType I would prefer to use this function instead of from_dtype_fallback but some some filesystems do not use d_type or set to 0 on EXT4/BTRFS this is fine however its not guaranteed so this is not really useful.

pub const fn is_dir(&self) -> bool

pub const fn is_regular_file(&self) -> bool

pub const fn is_symlink(&self) -> bool

pub const fn is_block_device(&self) -> bool

pub const fn is_char_device(&self) -> bool

pub const fn is_pipe(&self) -> bool

pub const fn is_socket(&self) -> bool

pub const fn is_unknown(&self) -> bool

pub const fn is_traversible(&self) -> bool

Returns true if the file type is traversible, i.e. a directory or sy symlink.

pub fn from_dtype_fallback(d_type: u8, file_path: &[u8]) -> Self

this is a fallback for when we can’t get the file type from libc this can happen on funky filesystems like NTFS/XFS, BTRFS/ext4 work fine.

pub fn from_bytes(file_path: &[u8]) -> Self

uses a lstat call to get the file type, more costly but more accurate this is used when we can’t get the file type from dirent64 due to funky filesystems

pub const fn from_mode(mode: mode_t) -> Self

pub fn from_path<P: AsRef<Path>>(path_start: P) -> Self

converts a FileType from a path via stdlib’s Path this is handy for verification, its not meant for use within iteration

pub const fn from_stat(stat: &stat) -> Self

Converts a libc::stat to a FileType This is useful for when you have a stat struct and want to get the file type without having to call lstat again.

pub const fn d_type_value(&self) -> u8

Returns the corresponding libc dirent d_type value

Trait Implementations

impl Clone for FileType

fn clone(&self) -> FileType

Returns a duplicate 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 Display for FileType

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

Formats the value using the given formatter.

impl From<stat> for FileType

fn from(stat: stat) -> Self

Converts to this type from the input type.

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, Self: Sized,

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FileType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FileType

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl Copy for FileType

impl Eq for FileType

impl StructuralPartialEq for FileType