Struct VisitOptions 

pub struct VisitOptions { /* private fields */ }

Shared directory traversal policy for collection and paged visiting. Defaults to immediate children only. Collection retains native batching; visiting delivers owned directory pages incrementally through callbacks. Unspecified budgets inherit the client’s resource limits.

Implementations

impl VisitOptions

pub const fn unlimited() -> VisitOptions

Explicitly disable entry, path-byte and depth limits. This can permit unbounded collection or traversal; prefer finite application budgets.

pub const fn new() -> VisitOptions

pub const fn recursive(self, value: bool) -> VisitOptions

Descend into directories, without following entry symlinks.

pub const fn max_entries(self, value: usize) -> VisitOptions

Shared entry budget across every input root.

pub const fn max_path_bytes(self, value: usize) -> VisitOptions

Shared path-byte budget. Recursive visiting also charges root paths.

pub const fn max_depth(self, value: usize) -> VisitOptions

Root listing is depth 0; depth 1 also lists immediate subdirectories. In recursive mode, encountering a directory beyond this limit is an error unless truncate_at_max_depth(true) is selected. Shallow mode ignores depth settings and intentionally visits only immediate children. Finite depths range from 0 through 200; any larger value disables the depth limit. Entry and path-byte budgets remain in effect.

pub const fn truncate_at_max_depth(self, value: bool) -> VisitOptions

Intentionally stop descending at the depth limit instead of failing.

pub const fn fields(self, value: AttrMask) -> VisitOptions

Select metadata returned with directory pages, without per-entry stat calls. Defaults to common stat fields. MODE is always requested for traversal; backends may return additional fields or omit unsupported ones.

pub const fn is_recursive(self) -> bool

pub fn metadata_fields(self) -> AttrMask

pub fn walk_options(self, limits: ResourceLimits) -> WalkOptions

Resolve recursive traversal limits against the client’s defaults.

pub fn directory_options(self, limits: ResourceLimits) -> ReadDirOptions

Resolve shallow listing limits against the client’s defaults.

Trait Implementations

impl Clone for VisitOptions

fn clone(&self) -> VisitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VisitOptions

impl Debug for VisitOptions

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

Formats the value using the given formatter.

impl Default for VisitOptions

fn default() -> VisitOptions

Returns the “default value” for a type.

impl Eq for VisitOptions

impl From<ReadDirOptions> for VisitOptions

fn from(options: ReadDirOptions) -> VisitOptions

Converts to this type from the input type.

impl From<WalkOptions> for VisitOptions

fn from(options: WalkOptions) -> VisitOptions

Converts to this type from the input type.

impl PartialEq for VisitOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VisitOptions