Struct MaxDepth 

pub struct MaxDepth(/* private fields */);

Accepts directories up to a certain depth.

The depth 1 means that only the base directory is visited.

Implementations

impl MaxDepth

pub fn new(max_depth: NonZeroUsize) -> Self

Creates a max depth filter.

This filter is dependant on the starting dir, it first retrieves the depth of the dir (right from the root ancestor) and then ensures that visited directories does not exceed the given depth (path to visit ancestor count - dir ancestor count).

You can also use Path::canonicalize to get the absolute path, which will also produce a higher depth (if it is not already canonical), however, ensure to only pass the canonicalized version to the visitor, otherwise, their depths will never match.

pub fn single_depth() -> Self

Creates a single depth filter (i.e, only visits files of provided directory).

This filter is dependant on the starting dir, it first retrieves the depth of the dir (right from the root ancestor) and then ensures that visited directories does not exceed the given depth (path to visit ancestor count - dir ancestor count).

You can also use Path::canonicalize to get the absolute path, which will also produce a higher depth (if it is not already canonical), however, ensure to only pass the canonicalized version to the visitor, otherwise, their depths will never match.

Trait Implementations

impl Clone for MaxDepth

fn clone(&self) -> MaxDepth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaxDepth

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

Formats the value using the given formatter.

impl Filter for MaxDepth

fn filter(&self, base_path: &Path, p: &Path) -> bool

Checks whether path_to_visit should be visited or not. The base_path is the initial directory provided to the visitor.

fn should_emit(&self, _: &Path) -> bool

Checks whether dir should be emitted by the iterator.

fn and<B>(self, other: B) -> And<Self, B>

where Self: Sized, B: Filter,

Creates a filter that only accepts both this and the other condition.

fn or<B>(self, other: B) -> Or<Self, B>

where Self: Sized, B: Filter,

Creates a filter that accepts this or the other condition.

fn not(self) -> Not<Self>

where Self: Sized,

Creates a filter that negates when this filter accepts.

impl Hash for MaxDepth

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 PartialEq for MaxDepth

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

impl Eq for MaxDepth

impl StructuralPartialEq for MaxDepth