Enum FileType 

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

Represents the type of a file in the filesystem

This enum provides a cross-platform abstraction for file types with specialised support for Unix filesystem semantics. It can be constructed from various sources including dirent d_type values, stat mode bits, and path-based lookups.

Examples

use fdf::FileType;
use libc::DT_DIR;

// Create from dirent d_type
let dir_type = FileType::from_dtype(DT_DIR);
assert!(dir_type.is_dir());

// Check if a file type is traversible
assert!(dir_type.is_traversible());

Variants

BlockDevice

Block special device file (e.g., /dev/sda)

CharDevice

Character special device file (e.g., /dev/tty)

Directory

Directory

Pipe

FIFO (named pipe)

Symlink

Symbolic link

RegularFile

Regular file

Socket

Socket file

Unknown

Unknown file type (should be rare on supported filesystems)

Implementations

impl FileType

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

Converts a libc dirent d_type value to a FileType

This is the preferred method when d_type is available, as it avoids expensive filesystem lookups. However, note that some filesystems may not support d_type or may set it to DT_UNKNOWN.

Parameters

• d_type: The file type from a dirent structure

Examples

use fdf::FileType;
use libc::{DT_DIR, DT_REG};

assert!(FileType::from_dtype(DT_DIR).is_dir());
assert!(FileType::from_dtype(DT_REG).is_regular_file());

pub const fn is_dir(&self) -> bool

Returns true if this represents a directory (cost free check)

pub const fn is_regular_file(&self) -> bool

Returns true if this represents a regular file (cost free check)

pub const fn is_symlink(&self) -> bool

Returns true if this represents a symbolic link (cost free check)

pub const fn is_block_device(&self) -> bool

Returns true if this represents a block device (cost free check)

pub const fn is_char_device(&self) -> bool

Returns true if this represents a character device (cost free check)

pub const fn is_pipe(&self) -> bool

Returns true if this represents a FIFO (named pipe) (cost free check)

pub const fn is_socket(&self) -> bool

Returns true if this represents a socket (cost free check)

pub const fn is_unknown(&self) -> bool

Returns true if this represents an unknown file type (cost free check)

pub const fn is_traversible(&self) -> bool

Returns true if the file type is traversible (directory or symlink)

This is useful for determining whether a directory entry can be explored further during filesystem traversal.

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

Fallback method to determine file type when d_type is unavailable or DT_UNKNOWN

This method first checks the d_type value, and if it’s DT_UNKNOWN, falls back to a more expensive lstat-based lookup using the file path.

Parameters

• d_type: The file type from a dirent structure
• file_path: The path to the file for fallback lookup

Notes

While ext4 and BTRFS (and others, not entirely tested!) typically provide reliable d_type values, other filesystems like NTFS, XFS, or FUSE-based filesystems may require the fallback path.

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

Determines file type using an lstat call on the provided path

This is more expensive but more reliable than relying on d_type, especially on filesystems that don’t fully support dirent d_type.

Parameters

• file_path: The path to the file to stat (must be a valid filepath)

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

Converts Unix mode bits to a FileType

This extracts the file type from the st_mode field of a stat structure.

Parameters

• mode: The mode bits from a stat structure

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

Determines file type using the standard library’s metadata lookup

This method is primarily useful for verification and testing purposes, not for use within performance-critical iteration code paths.

Parameters

• path_start: The path to examine

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

Converts a libc::stat structure to a FileType

Useful when you already have a stat structure and want to avoid additional filesystem lookups.

Parameters

• stat: The stat structure to extract the file type from

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 a libc::stat directly to a FileType

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