Struct tantivy::query::FuzzyTermQuery

pub struct FuzzyTermQuery { /* fields omitted */ }

A Fuzzy Query matches all of the documents containing a specific term that is within Levenshtein distance

use tantivy::collector::{Count, TopDocs};
use tantivy::query::FuzzyTermQuery;
use tantivy::schema::{Schema, TEXT};
use tantivy::{doc, Index, Term};

fn example() -> tantivy::Result<()> {
    let mut schema_builder = Schema::builder();
    let title = schema_builder.add_text_field("title", TEXT);
    let schema = schema_builder.build();
    let index = Index::create_in_ram(schema);
    {
        let mut index_writer = index.writer(3_000_000)?;
        index_writer.add_document(doc!(
            title => "The Name of the Wind",
        ));
        index_writer.add_document(doc!(
            title => "The Diary of Muadib",
        ));
        index_writer.add_document(doc!(
            title => "A Dairy Cow",
        ));
        index_writer.add_document(doc!(
            title => "The Diary of a Young Girl",
        ));
        index_writer.commit().unwrap();
    }
    let reader = index.reader()?;
    let searcher = reader.searcher();

    {
        let term = Term::from_field_text(title, "Diary");
        let query = FuzzyTermQuery::new(term, 1, true);
        let (top_docs, count) = searcher.search(&query, &(TopDocs::with_limit(2), Count)).unwrap();
        assert_eq!(count, 2);
        assert_eq!(top_docs.len(), 2);
    }

    Ok(())
}

Implementations

impl FuzzyTermQuery

pub fn new(
    term: Term,
    distance: u8,
    transposition_cost_one: bool
) -> FuzzyTermQuery

Creates a new Fuzzy Query

pub fn new_prefix(
    term: Term,
    distance: u8,
    transposition_cost_one: bool
) -> FuzzyTermQuery

Creates a new Fuzzy Query of the Term prefix

Trait Implementations

impl Clone for FuzzyTermQuery

fn clone(&self) -> FuzzyTermQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuzzyTermQuery

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

Formats the value using the given formatter.

impl Query for FuzzyTermQuery

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

Create the weight associated to a query.

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.

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

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