Struct DiscoveryOptions 

pub struct DiscoveryOptions {
    pub recursive: bool,
    pub follow_symlinks: bool,
    pub max_depth: Option<usize>,
    pub max_entries: Option<usize>,
    pub skip_directory_names: Vec<String>,
    pub skip_relative_prefixes: Vec<String>,
    pub skip_globs: Vec<String>,
    pub error_policy: TraversalErrorPolicy,
    pub deduplicate: bool,
    pub identity: PathIdentityOptions,
    pub sort: SortMode,
}

Available on crate feature listing only.

Options for recursive directory discovery.

Skip rules are caller-configured. This crate does not hardcode node_modules, .git, target, etc.

Depth model

Same as crate::listing::ListOptions:

• Depth 0 — the walk root
• Depth 1 — immediate children
• recursive: false limits the walk to depth 0 only (the root)
• recursive: true with max_depth: Some(n) uses walkdir max_depth = n

Fields

recursive: bool

Recurse into subdirectories.

follow_symlinks: bool

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

max_depth: Option<usize>

Maximum walk depth relative to the root (None = unlimited when recursive).

Depth 0 is the root itself; 1 is immediate children. Ignored when recursive is false (only the root is considered).

max_entries: Option<usize>

Maximum number of directories returned.

skip_directory_names: Vec<String>

Directory names to skip (exact component match). Never applied to the root itself.

skip_relative_prefixes: Vec<String>

Relative path prefixes (using / separators) to skip under the root.

skip_globs: Vec<String>

Available on crate feature search only.

Glob patterns matched against relative paths (requires search / globset).

error_policy: TraversalErrorPolicy

Error handling policy.

deduplicate: bool

Deduplicate results by identity key.

identity: PathIdentityOptions

Identity options used when deduplicate is true.

sort: SortMode

Sort mode for the returned list.

Implementations

impl DiscoveryOptions

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 skip_names( self, names: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Skip exact directory names (e.g. "node_modules").

pub fn skip_relative_prefixes( self, prefixes: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Skip relative path prefixes under the root.

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

Set maximum depth (see module / type docs).

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

Set maximum number of returned directories.

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

Set error policy.

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

Enable or disable identity-key deduplication.

pub fn identity(self, identity: PathIdentityOptions) -> Self

Identity options used when deduplicating.

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

Sort mode for the returned list.

Trait Implementations

impl Clone for DiscoveryOptions

fn clone(&self) -> DiscoveryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiscoveryOptions

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

Formats the value using the given formatter.

impl Default for DiscoveryOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DiscoveryOptions

impl PartialEq for DiscoveryOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DiscoveryOptions