[][src]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.

Methods

impl PhraseQuery[src]

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

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[src]

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

Can be used to provide custom offset for each term.

pub fn field(&self) -> Field[src]

The Field this PhraseQuery is targeting.

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

Terms in the phrase without the associated offsets.

Trait Implementations

impl Query for PhraseQuery[src]

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

Create the weight associated to a query.

See Weight.

impl Clone for PhraseQuery[src]

impl Debug for PhraseQuery[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Fruit for T where
    T: Send + Downcast
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Erased for T[src]

impl<T> Downcast for T where
    T: Any
[src]

impl<T> DowncastSync for T where
    T: Send + Sync + Any
[src]