Struct ListOptions 

pub struct ListOptions {
    pub recursive: bool,
    pub follow_symlinks: bool,
    pub include_files: bool,
    pub include_directories: bool,
    pub include_symlinks: bool,
    pub include_hidden: bool,
    pub include_other: bool,
    pub max_depth: Option<usize>,
    pub max_entries: Option<usize>,
    pub sort: SortMode,
    pub error_policy: TraversalErrorPolicy,
    pub include_root: bool,
}

Available on crate feature listing only.

Options controlling directory listing and traversal.

Defaults

• Non-recursive (immediate children only)
• Do not follow symlinks
• Include files and directories
• Include symlinks as entries (not followed)
• Exclude hidden entries
• Fail-fast on errors
• Sort by path

See module docs for the unified depth model shared with discovery.

Fields

recursive: bool

Recurse into subdirectories.

follow_symlinks: bool

Follow symbolic links (cycle detection is best-effort via walkdir).

include_files: bool

Include regular files.

include_directories: bool

Include directories.

include_symlinks: bool

Include symlink entries (when not followed into).

include_hidden: bool

Include hidden entries (dotfiles; Windows hidden attribute when available).

include_other: bool

Include other entry types (sockets, devices, etc.).

max_depth: Option<usize>

Maximum walk depth when recursive is true (None = unlimited).

Depth 0 is the root; depth 1 is immediate children. See module docs. Ignored when recursive is false (only depth-1 children are listed).

max_entries: Option<usize>

Maximum number of returned entries.

sort: SortMode

Result sort mode (list only; walk always yields in walk order).

error_policy: TraversalErrorPolicy

Error handling policy.

include_root: bool

When true, include the root directory itself as an entry.

Implementations

impl ListOptions

pub fn new() -> Self

Create default options (Self::default()).

pub fn recursive(self, recursive: bool) -> Self

Enable or disable recursion.

pub fn follow_symlinks(self, follow: bool) -> Self

Follow symlinks when walking.

pub fn include_files(self, include: bool) -> Self

Include regular files.

pub fn include_directories(self, include: bool) -> Self

Include directories.

pub fn include_symlinks(self, include: bool) -> Self

Include symlink entries.

pub fn include_other(self, include: bool) -> Self

Include other entry types.

pub fn include_hidden(self, include: bool) -> Self

Include hidden files and directories.

pub fn max_depth(self, depth: Option<usize>) -> Self

Set maximum depth (see module depth model).

pub fn max_entries(self, max: Option<usize>) -> Self

Set maximum number of entries.

pub fn sort(self, sort: SortMode) -> Self

Set sort mode (applies to list, not walk).

pub fn error_policy(self, policy: TraversalErrorPolicy) -> Self

Set error policy.

pub fn include_root(self, include: bool) -> Self

Include the root directory itself.

Trait Implementations

impl Clone for ListOptions

fn clone(&self) -> ListOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListOptions

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

Formats the value using the given formatter.

impl Default for ListOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ListOptions

impl PartialEq for ListOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ListOptions