Struct CompactPathTree

pub struct CompactPathTree { /* private fields */ }

A compact immutable representation of the paths within a directory.

Implementations

impl CompactPathTree

pub fn new(root: PathBuf, visitor: &mut impl PathVisitor) -> Result<Self>

Construct a new CompactPathTree by doing a depth-first traversal of the given directory.

The given visitor is used to determine which items should be included and what errors are fatal.

Symbolic links will be stored in the tree, but not followed.

pub fn inner(&self) -> &Path

Get the underlying path this tree is represented as.

pub fn root(&self) -> &Path

Get the root path this tree was constructed from.

pub fn iter(&self) -> CompactPathTreeIter<'_>

Get an iterator over the paths stored in this tree.

The root path isn’t included in the output of this iterator, only its contents are. The paths are iterated in a depth-first traversal of the tree, with parents being emitted before children. No other guarantees are made with regards to ordering.

Trait Implementations

impl Clone for CompactPathTree

fn clone(&self) -> CompactPathTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> IntoIterator for &'a CompactPathTree

type Item = PathBuf

The type of the elements being iterated over.

type IntoIter = CompactPathTreeIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for CompactPathTree

fn eq(&self, other: &CompactPathTree) -> 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 Eq for CompactPathTree

impl StructuralPartialEq for CompactPathTree