Struct wax::WalkBehavior
source · pub struct WalkBehavior {
pub depth: usize,
pub link: LinkBehavior,
}
walk
only.Expand description
Configuration for matching Glob
s against directory trees.
Determines the behavior of the traversal within a directory tree when using functions like
Glob::walk
. 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::{Glob, LinkBehavior};
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 entry for the root.
The default value is usize::MAX
.
link: LinkBehavior
Interpretation of symbolic links.
Determines how symbolic links are interpreted when traversing a directory tree. See
LinkBehavior
.
The default value is LinkBehavior::ReadFile
.
Trait Implementations§
source§impl Clone for WalkBehavior
impl Clone for WalkBehavior
source§fn clone(&self) -> WalkBehavior
fn clone(&self) -> WalkBehavior
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WalkBehavior
impl Debug for WalkBehavior
source§impl Default for WalkBehavior
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 |
source§impl From<()> for WalkBehavior
impl From<()> for WalkBehavior
source§impl From<LinkBehavior> for WalkBehavior
impl From<LinkBehavior> for WalkBehavior
source§fn from(link: LinkBehavior) -> Self
fn from(link: LinkBehavior) -> Self
source§impl From<usize> for WalkBehavior
impl From<usize> for WalkBehavior
source§impl PartialEq for WalkBehavior
impl PartialEq for WalkBehavior
source§fn eq(&self, other: &WalkBehavior) -> bool
fn eq(&self, other: &WalkBehavior) -> bool
self
and other
values to be equal, and is used
by ==
.