Struct tantivy::query::PhrasePrefixQuery

pub struct PhrasePrefixQuery { /* private fields */ }

PhrasePrefixQuery matches a specific sequence of words followed by term of which only a prefix is known.

For instance the phrase prefix query for "part t" 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 PhrasePrefixQuery on a field requires positions to be indexed for this field.

Implementations

impl PhrasePrefixQuery

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

Creates a new PhrasePrefixQuery 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 The last Term is a prefix and not a full value

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

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

Can be used to provide custom offset for each term.

pub fn set_max_expansions(&mut self, value: u32)

Maximum number of terms to which the last provided term will expand.

pub fn field(&self) -> Field

The Field this PhrasePrefixQuery is targeting.

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

Terms in the phrase without the associated offsets.

Trait Implementations

impl Clone for PhrasePrefixQuery

fn clone(&self) -> PhrasePrefixQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhrasePrefixQuery

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

Formats the value using the given formatter.

impl Query for PhrasePrefixQuery

fn weight(&self, enable_scoring: EnableScoring<'_>) -> Result<Box<dyn Weight>>

Create the weight associated with a query.

See Weight.

fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool))

Extract all of the terms associated with the query and pass them to the given closure.

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.