Struct wax::walk::WalkBehavior

pub struct WalkBehavior {
    pub depth: usize,
    pub link: LinkBehavior,
}

Available on crate feature walk only.

Configuration for walking directory trees.

Determines the behavior of the traversal within a directory tree when using functions like Glob::walk_with_behavior. WalkBehavior can be constructed via conversions from types representing its fields. APIs generally accept impl Into<WalkBehavior>, so these conversion can be used implicitly. When constructed using such a conversion, WalkBehavior will use defaults for any remaining fields.

Examples

By default, symbolic links are interpreted as regular files and targets are ignored. To read linked targets, use LinkBehavior::ReadTarget.

use wax::walk::LinkBehavior;
use wax::Glob;

for entry in Glob::new("**")
    .unwrap()
    .walk_with_behavior(".", LinkBehavior::ReadTarget)
{
    let entry = entry.unwrap();
    // ...
}

Fields

depth: usize

Maximum depth.

Determines the maximum depth to which a directory tree will be traversed relative to the root. A depth of zero corresponds to the root and so using such a depth will yield at most one file entry that refers to the root.

For PathExt::walk, this depth is relative to the Path receiver. For Glob::walk, this depth is relative to the directory path parameter.

The default value is usize::MAX.

link: LinkBehavior

Interpretation of symbolic links.

Determines how symbolic links are interpreted when walking a directory tree. See LinkBehavior.

The default value is LinkBehavior::ReadFile.

Trait Implementations

impl Clone for WalkBehavior

fn clone(&self) -> WalkBehavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalkBehavior

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

Formats the value using the given formatter.

impl Default for WalkBehavior

Constructs a WalkBehavior using the following defaults:

Field	Description	Value
depth	Maximum depth.	usize::MAX
link	Interpretation of symbolic links.	LinkBehavior::ReadFile

fn default() -> Self

Returns the “default value” for a type.

impl From<()> for WalkBehavior

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<LinkBehavior> for WalkBehavior

fn from(link: LinkBehavior) -> Self

Converts to this type from the input type.

impl From<usize> for WalkBehavior

fn from(depth: usize) -> Self

Converts to this type from the input type.

impl PartialEq<WalkBehavior> for WalkBehavior

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for WalkBehavior

impl Eq for WalkBehavior

impl StructuralEq for WalkBehavior

impl StructuralPartialEq for WalkBehavior