Struct SearchOptions 

pub struct SearchOptions {
    pub base_dirs: Vec<PathBuf>,
    pub pattern: String,
    pub max_depth: u32,
    pub include_dirs: bool,
    pub case_insensitive: bool,
    pub search_in_files: bool,
    pub include_patterns: Vec<String>,
    pub exclude_dirs: Vec<String>,
    pub max_line_length: usize,
    pub binary_check_bytes: usize,
    pub max_results: usize,
}

All parameters that control a single search operation.

Use SearchOptions::builder for a fluent construction API, or construct directly for multi-path searches via SearchOptions::base_dirs.

Fields

base_dirs: Vec<PathBuf>

One or more directories to search. At least one must be provided. When multiple directories are given, results from all roots are merged and de-duplicated.

pattern: String

Pattern to match (supports * / ? wildcards, or plain substring).

max_depth: u32

Maximum recursion depth per directory (0 = only that directory itself).

include_dirs: bool

Include directory entries in filename-search results.

case_insensitive: bool

Match case-insensitively.

search_in_files: bool

Search for pattern inside file contents instead of matching names.

include_patterns: Vec<String>

Only include files that match these glob patterns (empty = all).

exclude_dirs: Vec<String>

Directory names to skip entirely during traversal.

max_line_length: usize

Lines longer than this are skipped during content search.

binary_check_bytes: usize

Bytes read to probe for binary content.

max_results: usize

Cap the total number of results returned (0 = unlimited).

Implementations

impl SearchOptions

pub fn from_config( cfg: &Config, base_dirs: Vec<PathBuf>, pattern: String, ) -> Self

Construct from a Config with explicit directories and a pattern.

pub fn builder(pattern: impl Into<String>) -> SearchOptionsBuilder

Fluent builder — start with a pattern.

Trait Implementations

impl Clone for SearchOptions

fn clone(&self) -> SearchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchOptions

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

Formats the value using the given formatter.