Enum DirectoryScanDepthLimit 

pub enum DirectoryScanDepthLimit {
    Unlimited,
    Limited {
        maximum_depth: usize,
    },
}

The maximum directory scan depth option.

Used primarily in DirectoryScanner.

Variants

Unlimited

No scan depth limit.

Limited

Scan depth is limited to maximum_depth, where the value refers to the maximum depth of the subdirectory whose contents are still listed.

Examples

maximum_depth = 0 indicates a scan that will cover only the files and directories directly in the source directory.

~/scanned-directory
 |- foo.csv
 |- foo-2.csv
 |- bar/
    (no entries listed)

Notice how contents of the ~/scanned-directory/bar/ directory are not returned in the scan when using depth 0.

maximum_depth = 1 will cover the files and directories directly in the source directory plus one level of files and subdirectories deeper.

~/scanned-directory
 |- foo.csv
 |- foo-2.csv
 |- bar/
    |- hello-world.txt
    |- bar2/
       (no entries listed)

Notice how contents of ~/scanned-directory/bar are listed, but contents of ~/scanned-directory/bar/bar2 are not.

Fields

maximum_depth: usize

Maximum scan depth.

Trait Implementations

impl Clone for DirectoryScanDepthLimit

fn clone(&self) -> DirectoryScanDepthLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryScanDepthLimit

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

Formats the value using the given formatter.

impl Hash for DirectoryScanDepthLimit

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 DirectoryScanDepthLimit

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

impl Eq for DirectoryScanDepthLimit

impl StructuralPartialEq for DirectoryScanDepthLimit