Enum file_structure::FileType

pub enum FileType {
    Regular,
    Directory(Vec<File>),
    Symlink(PathBuf),
}

Variants

Regular

Directory(Vec<File>)

Symlink(PathBuf)

Implementations

impl FileType

pub fn from_path(
    path: impl AsRef<Path>,
    follow_symlinks: bool
) -> FSResult<Self>

Recursively creates FileType from path.

Example

use file_structure::{FileType, FSError};

fn main() -> Result<(), FSError> {
    let file_type = FileType::from_path("src/", true)?;

    if let FileType::Directory(ref children) = file_type {
        println!("We found {} files!", children.len()); // vec.len()

        for child in children {
            println!("{:#?}", child);
        }
    }
    Ok(())
}

Useful when

Notes:

If follow_symlinks is true, when gathering information about the file type, this function will make a system call that traverses paths until there is no symlink left, this means that the return type in this case can never be the variant FileType::Symlink(_), if you want to read from the path and also check if it is a symlink, set follow_symlinks to false.

For each directory, call the function recursively.

See also from_path_shallow.

pub fn from_path_shallow(
    path: impl AsRef<Path>,
    follow_symlink: bool
) -> FSResult<Self>

Similar to from_path, but leaves Directory and Symlink empty.

This function is guaranteed to only make one syscall for the FileType, this means that it cannot read all the elements from inside of the directories.

This is useful when you want to make a quick check on a file type without going into it's thousand subsequent files, that would take a lot of time.

Example:

use file_structure::{FileType, FSError};

fn main() -> Result<(), FSError> {
    let file_type = FileType::from_path_shallow("/sbin", true)?;

    if !file_type.is_dir() {
        println!("There's something wrong with our file system.");
    }
    Ok(())
}

pub fn is_regular(&self) -> bool

Checks variant FileType::Regular(_)

pub fn is_dir(&self) -> bool

Checks variant FileType::Directory(_)

pub fn is_symlink(&self) -> bool

Checks variant FileType::Symlink(_)

pub fn children(&self) -> Option<&Vec<File>>

Shorthand for unpacking FileType::Directory(ref children)

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

fn default() -> Self

Returns the "default value" for a type.

impl Display for FileType

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

Formats the value using the given formatter.

impl Eq for 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, 

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

fn ne(&self, other: &FileType) -> 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.

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

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

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

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

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

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

fn ge(&self, other: &FileType) -> 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