Struct tantivy::query::TermQuery

pub struct TermQuery { /* fields omitted */ }

A Term query matches all of the documents containing a specific term.

The score associated is defined as idf * sqrt(term_freq / field norm) in which :

• idf - inverse document frequency.
• term_freq - number of occurrences of the term in the field
• field norm - number of tokens in the field.

Methods

impl TermQuery

pub fn new(term: Term, segment_postings_options: IndexRecordOption) -> TermQuery

Creates a new term query.

pub fn specialized_weight(&self, searcher: &Searcher) -> TermWeight

Returns a weight object.

While .weight(...) returns a boxed trait object, this method return a specific implementation. This is useful for optimization purpose.

Trait Implementations

impl Debug for TermQuery

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Query for TermQuery

fn as_any(&self) -> &Any

Used to make it possible to cast Box into a specific type. This is mostly useful for unit tests.

fn weight(&self, searcher: &Searcher) -> Result<Box<Weight>>

Create the weight associated to a query.

fn search(
    &self,
    searcher: &Searcher,
    collector: &mut Collector
) -> Result<TimerTree>

Search works as follows :