Struct fs_tree::FileTree

pub struct FileTree {
    pub path: PathBuf,
    pub file_type: FileTreeType,
}

A filesystem tree recursive type.

Fields

path: PathBuf

The filename of this file.

file_type: FileTreeType

The filetype of this file.

Implementations

impl FileTree

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

Creates a FileTree::Regular from arguments.

pub fn new_directory(path: impl AsRef<Path>, children: Vec<Self>) -> Self

Creates a FileTree::Directory from arguments.

pub fn new_symlink(path: impl AsRef<Path>, target_path: impl AsRef<Path>) -> Self

Creates a FileTree::Symlink from arguments.

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

Collects a Vec of FileTree from path that is a directory.

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

Collects a Vec of FileTree from path that is a directory, entries can be symlinks.

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

Collects a Vec of FileTree from path that is a directory.

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

Collects a Vec of FileTree from path that is a directory, entries can be symlinks.

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

Builds a FileTree from path, follows symlinks.

Similar to from_path_symlink.

If file at path is a regular file, will return a FileTree::Regular. If file at path is a directory file, FileTree::Directory (with .children).

Errors:

• If Io::Error from fs::metadata(path)
• If it is a directory, and Io::Error from fs::read_dir(path) iterator usage
• If unexpected file type at path

This function traverses symlinks until final destination, and then reads it, so it can never return Ok(FileTree::Symlink { .. ]}), if you wish otherwise, use FileTree::from_path_symlink instead.

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

Builds a FileTree from path, follows symlinks.

Similar to from_path_symlink.

If file at path is a regular file, will return a FileTree::Regular. If file at path is a directory file, FileTree::Directory (with children field). If file at path is a symlink file, FileTree::Symlink (with target_path field).

Errors:

• If Io::Error from fs::metadata(path)
• If it is a directory, and Io::Error from fs::read_dir(path) iterator usage
• If it is a symlink, and Io::Error from fs::read_link(path)
• If unexpected file type at path

If you wish to traverse symlinks until final destination, instead, use FileTree::from_path.

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

cd into path, run from_path, and come back.

TODO explain here why this is useful

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

cd into path, run from_path_symlink, and come back.

TODO explain here why this is useful

pub fn from_path_text(path: impl AsRef<Path>) -> Option<Self>

Splits a Path components into a FileTree.

Returns None if the string is empty.

Can only build Regular and Directory, not symlink.

Example:

use fs_tree::FileTree;

let result = FileTree::from_path_text(".config/i3/file");

let expected = {
    FileTree::new_directory(
        ".config/",
        vec![FileTree::new_directory(
            ".config/i3/",
            vec![FileTree::new_regular(".config/i3/file")],
        )],
    )
};

assert_eq!(result, Some(expected));

pub fn from_path_pieces<I, P>(path_iter: I) -> Option<Self> where
    I: IntoIterator<Item = P>,
    P: AsRef<Path>, 

More generic version of FileTree::from_path_text.

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

Iterator of all FileTrees in the structure

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

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

pub fn make_paths_relative(&mut self)

Fix relative paths from each node piece.

If you manually build a structure like:

"a": [
    "b": [
        "c",
    ]
]

Using the create methods, then you need to run this function to make them relative paths.

"a": [
    "a/b": [
        "a/b/c",
    ]
]

Then, you can access any of the files only by looking at their path.

pub fn make_paths_absolute(&mut self) -> Result<()>

Makes all paths in the tree absolute.

Errors:

In case std::fs::canonicalize fails at any path, this function will stop and return an IoError, leave the tree in a mixed state in terms of canonical paths.

pub fn merge(self, other: Self) -> Option<Self>

Merge this tree with other FileTree.

This function is currently experimental and likely to change in future versions.

Errors:

This errs if:

• The trees have different roots and thus cannot be merged.
• There are file conflicts.

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

Reference to children vec if self.is_directory().

pub fn children_mut(&mut self) -> Option<&mut Vec<Self>>

Reference to children vec if self.is_directory(), mutable.

pub fn target(&self) -> Option<&PathBuf>

Reference to target_path if self.is_symlink().

pub fn target_mut(&mut self) -> Option<&mut PathBuf>

Reference to target_path if self.is_symlink(), mutable.

pub fn apply_to_children0(&mut self, f: impl FnMut(&mut Self))

Apply a closure for each direct child of this FileTree.

Only 1 level deep.

pub fn apply_to_all_children1(&mut self, f: impl FnMut(&mut Self) + Copy)

Apply a closure to all direct and indirect descendants inside of this structure.

Calls recursively for all levels.

pub fn apply_to_all(&mut self, f: impl FnMut(&mut Self) + Copy)

Apply a closure to all direct and indirect descendants inside, also includes root.

Calls recursively for all levels.

pub fn path(&self) -> &PathBuf

Gets a reference to the file path to this node.

pub fn path_mut(&mut self) -> &mut PathBuf

Gets a mutable reference to the file path to this node.

pub fn is_regular(&self) -> bool

Shorthand for file.file_type.is_regular()

pub fn is_dir(&self) -> bool

Shorthand for file.file_type.is_dir()

pub fn is_symlink(&self) -> bool

Shorthand for file.file_type.is_symlink()

pub fn to_regular(&mut self)

Turn this node of the tree into a regular file.

Beware the possible recursive drop of nested nodes if this node was a directory.

pub fn to_directory(&mut self, children: Vec<Self>)

Turn this node of the tree into a directory.

Beware the possible recursive drop of nested nodes if this node was a directory.

pub fn to_symlink(&mut self, target_path: impl AsRef<Path>)

Turn this node of the tree into a symlink.

Beware the possible recursive drop of nested nodes if this node was a directory.

pub fn has_same_type_as(&self, other: &FileTree) -> bool

Checks if the FileTree file type is the same as other FileTree.

Trait Implementations

impl Clone for FileTree

fn clone(&self) -> FileTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileTree

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

Formats the value using the given formatter.

impl Hash for FileTree

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 FileTree

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<FileTree> for FileTree

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

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

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

This method tests for !=.

impl PartialOrd<FileTree> for FileTree

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

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

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

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

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

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

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

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

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 Eq for FileTree

impl StructuralEq for FileTree

impl StructuralPartialEq for FileTree