Struct NameQuery 

pub struct NameQuery { /* private fields */ }

A query for searching the name index.

A query provides the name query and defines the maximum number of results returned by searching the name index.

Implementations

impl NameQuery

pub fn new(name: &str) -> NameQuery

Create a query that searches the given name.

pub fn with_size(self, size: usize) -> NameQuery

Set this query’s result set size. At most size results will be returned when searching with this query.

pub fn with_scorer(self, scorer: NameScorer) -> NameQuery

Set this query’s scorer. By default, Okapi BM25 is used.

pub fn with_stop_word_ratio(self, ratio: f64) -> NameQuery

Set the ratio (in the range 0.0 to 1.0, inclusive) at which a term is determined to be a stop word. Set to 0.0 to disable. By default this is set to a non-zero value.

This ratio is used at query time to partition all of the ngrams in the query into two bins: one bin is for “low frequency” ngrams while the other is for “high frequency” ngrams. The partitioning is determined by this ratio. Namely, if an ngram occurs in fewer than ratio documents in the entire corpus, then it is considered a low frequency ngram.

Once these two partitions are created, both are used to create two disjunction queries. The low frequency query drives search results, while the high frequency query is only used to boost scores when it matches a result yielded by the low frequency query. Otherwise, results from the high frequency query aren’t considered.

Trait Implementations

impl Clone for NameQuery

fn clone(&self) -> NameQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NameQuery

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

Formats the value using the given formatter.