Struct SearchOptions

Source

pub struct SearchOptions<'a> {Show 20 fields
    pub db_path: &'a Path,
    pub query: &'a str,
    pub path_filter: Option<&'a PathBuf>,
    pub kind_filter: Option<&'a str>,
    pub language_filter: Option<&'a str>,
    pub limit: usize,
    pub use_regex: bool,
    pub candidates: usize,
    pub context: ContextOptions,
    pub snippet: SnippetOptions,
    pub fqn: FqnOptions,
    pub include_score: bool,
    pub sort_by: SortMode,
    pub metrics: MetricsOptions,
    pub ast: AstOptions<'a>,
    pub depth: DepthOptions<'a>,
    pub algorithm: AlgorithmOptions<'a>,
    pub symbol_id: Option<&'a str>,
    pub fqn_pattern: Option<&'a str>,
    pub exact_fqn: Option<&'a str>,
}

Expand description

Options for all search functions

Fields§

§db_path: &'a Path

Database path

§query: &'a str

Search query string

§path_filter: Option<&'a PathBuf>

Optional path filter

§kind_filter: Option<&'a str>

Optional kind filter (symbols only) - comma-separated values

§language_filter: Option<&'a str>

Optional language filter (symbols only)

§limit: usize

Maximum results to return

§use_regex: bool

Use regex matching

§candidates: usize

Candidate limit for filtering

§context: ContextOptions

Context options

§snippet: SnippetOptions

Snippet options

§fqn: FqnOptions

FQN options (symbols only)

§include_score: bool

Include score in results

§sort_by: SortMode

Sorting mode for results

§metrics: MetricsOptions

Metrics filtering options

§ast: AstOptions<'a>

AST filtering options

§depth: DepthOptions<'a>

Depth filtering options

§algorithm: AlgorithmOptions<'a>

Algorithm-based filtering options

§symbol_id: Option<&'a str>

SymbolId for direct BLAKE3 hash lookup (overrides name-based search)

§fqn_pattern: Option<&'a str>

FQN pattern filter (LIKE match on canonical_fqn)

§exact_fqn: Option<&'a str>

Exact FQN filter (exact match on canonical_fqn)

Trait Implementations§

Source §

impl<'a> Clone for SearchOptions<'a>

Source §

fn clone(&self) -> SearchOptions<'a>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<'a> Debug for SearchOptions<'a>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> UnwindSafe for SearchOptions<'a>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §