Struct tantivy::query::PhraseQuery

pub struct PhraseQuery { /* fields omitted */ }

PhraseQuery matches a specific sequence of words.

For instance the phrase query for "part time" will match the sentence

Alan just got a part time job.

On the other hand it will not match the sentence.

This is my favorite part of the job.

Using a PhraseQuery on a field requires positions to be indexed for this field.

Implementations

impl PhraseQuery

pub fn new(terms: Vec<Term>) -> PhraseQuery

Creates a new PhraseQuery given a list of terms.

There must be at least two terms, and all terms must belong to the same field. Offset for each term will be same as index in the Vector

pub fn new_with_offset(terms: Vec<(usize, Term)>) -> PhraseQuery

Creates a new PhraseQuery given a list of terms and their offsets.

Can be used to provide custom offset for each term.

pub fn field(&self) -> Field

The Field this PhraseQuery is targeting.

pub fn phrase_terms(&self) -> Vec<Term>

Terms in the phrase without the associated offsets.

Trait Implementations

impl Clone for PhraseQuery

fn clone(&self) -> PhraseQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhraseQuery

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

Formats the value using the given formatter.

impl Query for PhraseQuery

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

Create the weight associated to a query.

See Weight.

fn query_terms(&self, terms: &mut BTreeMap<Term, bool>)

Extract all of the terms associated to the query and insert them in the term set given in arguments.

fn explain(
    &self,
    searcher: &Searcher,
    doc_address: DocAddress
) -> Result<Explanation>

Returns an Explanation for the score of the document.

fn count(&self, searcher: &Searcher) -> Result<usize>

Returns the number of documents matching the query.