Struct file_structure::File

pub struct File {
    pub path: PathBuf,
    pub file_type: FileType,
}

Fields

path: PathBuf

file_type: FileType

Implementations

impl<'a> File

pub fn new(path: impl AsRef<Path>, file_type: FileType) -> Self

Create File from arguments

This function will panic if you pass a path with multiple components to it, because it breaks iterators functionality.

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

Create File reading from the path

pub fn files(&'a self) -> FilesIter<'a>

Iterator of all Files in the structure

pub fn paths(&'a self) -> PathsIter<'a>

Shorthand for self.files().paths(), see link to .paths() method

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

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the "default value" for a type.

impl Eq for File

impl Hash for File

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 File

fn cmp(&self, other: &File) -> 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<File> for File

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

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

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

This method tests for !=.

impl PartialOrd<File> for File

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for File

impl StructuralPartialEq for File