Struct tantivy::query::RegexQuery

pub struct RegexQuery { /* fields omitted */ }

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

#[macro_use]
extern crate tantivy;
use tantivy::schema::{Schema, TEXT};
use tantivy::{Index, Result, Term};
use tantivy::collector::Count;
use tantivy::query::RegexQuery;

fn example() -> 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 = RegexQuery::new("d[ai]{2}ry".to_string(), title);
    let count = searcher.search(&query, &Count)?;
    assert_eq!(count, 3);
    Ok(())
}

Methods

impl RegexQuery

pub fn new(regex_pattern: String, field: Field) -> RegexQuery

Creates a new Fuzzy Query

Trait Implementations

impl Query for RegexQuery

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 BTreeSet<Term>)

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

impl Clone for RegexQuery

fn clone(&self) -> RegexQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegexQuery

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

Formats the value using the given formatter.