Struct SearchConfig

Source

pub struct SearchConfig {Show 13 fields
    pub max_query_variants: usize,
    pub max_search_keys_per_candidate: usize,
    pub max_total_key_bytes_per_candidate: usize,
    pub limit: usize,
    pub top_b_for_quality_score: usize,
    pub exact: bool,
    pub extended: bool,
    pub case_sensitive: bool,
    pub disabled: bool,
    pub no_sort: bool,
    pub normalize: bool,
    pub matcher_algo: MatcherAlgo,
    pub tiebreaks: Vec<Tiebreak>,
}

Expand description

Search and ranking configuration used by index and query execution.

Fields§

§max_query_variants: usize

Maximum number of expanded query variants kept for one query.

§max_search_keys_per_candidate: usize

Maximum number of search keys kept for one candidate.

§max_total_key_bytes_per_candidate: usize

Maximum total UTF-8 bytes for non-base search keys on one candidate.

§limit: usize

Maximum number of results returned after ranking.

§top_b_for_quality_score: usize

Number of top candidates to rescore for quality-oriented ordering.

§exact: bool

Uses exact substring scoring instead of fuzzy subsequence scoring.

§extended: bool

Enables fzf-style extended query syntax.

§case_sensitive: bool

Preserves case during matching when true.

§disabled: bool

Disables filtering and returns candidates in ranking order only.

§no_sort: bool

Keeps input order instead of sorting by score.

§normalize: bool

Adds normalized candidate and query keys.

§matcher_algo: MatcherAlgo

Fuzzy matcher implementation used for scoring.

§tiebreaks: Vec<Tiebreak>

Ordered tiebreak rules applied after score comparison.

Implementations§

Source §

impl SearchConfig

Source

pub fn key_budget(&self) -> KeyBudget

Returns the candidate-key generation budget represented by this config.

Source

pub fn query_budget(&self) -> QueryBudget

Returns the query-variant generation budget represented by this config.

Trait Implementations§

Source §

impl Clone for SearchConfig

Source §

fn clone(&self) -> SearchConfig

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for SearchConfig

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for SearchConfig

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for SearchConfig

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 §