Struct SearchOptions 

pub struct SearchOptions {

    pub extensions: Option<Vec<String>>,
    pub ignore_case: bool,
    pub fuzzy: bool,
    pub fuzzy_threshold: f64,
    pub max_results: usize,
    pub exclude: Option<Vec<String>>,
    pub rank: bool,
    pub cache: bool,
    pub semantic: bool,
    pub benchmark: bool,
    pub vs_grep: bool,
    pub use_bm25: bool,
    pub context_filter: Option<ContextFilter>,
    pub fixed_string: bool,
    pub declaration_filter: Option<DeclarationFilter>,
    pub context: usize,
}

Search options to bundle related parameters

Fields

extensions: Option<Vec<String>>

ignore_case: bool

fuzzy: bool

fuzzy_threshold: f64

max_results: usize

exclude: Option<Vec<String>>

rank: bool

cache: bool

semantic: bool

benchmark: bool

vs_grep: bool

use_bm25: bool

context_filter: Option<ContextFilter>

fixed_string: bool

declaration_filter: Option<DeclarationFilter>

context: usize

Number of context lines to show around each match (0 = none)

Implementations

impl SearchOptions

pub fn with_extensions(self, extensions: Vec<String>) -> Self

Builder pattern: set extensions

pub fn with_ignore_case(self, ignore_case: bool) -> Self

Builder pattern: set ignore_case

pub fn with_fuzzy(self, fuzzy: bool) -> Self

Builder pattern: set fuzzy

pub fn with_fuzzy_threshold(self, threshold: f64) -> Self

Builder pattern: set fuzzy_threshold

pub fn with_max_results(self, max: usize) -> Self

Builder pattern: set max_results

pub fn with_exclude(self, exclude: Vec<String>) -> Self

Builder pattern: set exclude

pub fn with_rank(self, rank: bool) -> Self

Builder pattern: set rank

pub fn with_cache(self, cache: bool) -> Self

Builder pattern: set cache

pub fn with_semantic(self, semantic: bool) -> Self

Builder pattern: set semantic

pub fn with_benchmark(self, benchmark: bool) -> Self

Builder pattern: set benchmark

pub fn with_vs_grep(self, vs_grep: bool) -> Self

Builder pattern: set vs_grep

pub fn with_context(self, context: usize) -> Self

Builder pattern: set context lines around matches

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.

impl Default for SearchOptions

fn default() -> Self

Returns the “default value” for a type.