Skip to main content

WalkOptions

Struct WalkOptions 

Source
pub struct WalkOptions {
    pub follow_links: bool,
    pub max_depth: usize,
    pub ignore_errors: bool,
}
Expand description

Configuration structure to customize the behavior of the walker, including depth limits and error handling policies. Configuration structure to customize the behavior of the directory walker.

This struct allows the user to define how the walker should handle symbolic links, how deep the recursion should go, and whether it should halt on errors.

Fields§

§follow_links: bool

Specifies whether the walker should follow symbolic links to directories. If set to true, the walker will recurse into linked directories.

§max_depth: usize

The maximum number of directory levels to descend. A depth of 0 only visits the root path.

§ignore_errors: bool

If set to true, I/O errors and symbolic link loops encountered during iteration will be silently skipped.

Trait Implementations§

Source§

impl Clone for WalkOptions

Source§

fn clone(&self) -> WalkOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WalkOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WalkOptions

Source§

fn default() -> Self

Provides the default configuration for directory traversal.

§Returns

Returns a WalkOptions instance with the following defaults:

  • follow_links: false - Does not follow symbolic links to prevent accidental loops.
  • max_depth: 512 - A conservative limit to prevent stack exhaustion in extremely deep trees.
  • ignore_errors: false - All errors are reported to the user by default for maximum safety.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.