Struct RegexQuery 

pub struct RegexQuery { /* private fields */ }

A Regex Query matches all of the documents containing a specific term that matches a regex pattern.

Wildcard queries (e.g. ho*se) can be achieved by converting them to their regex counterparts.

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

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()?;
}

let reader = index.reader()?;
let searcher = reader.searcher();

let term = Term::from_field_text(title, "Diary");
let query = RegexQuery::from_pattern("d[ai]{2}ry", title)?;
let count = searcher.search(&query, &Count)?;
assert_eq!(count, 3);
Ok(())

Implementations

impl RegexQuery

pub fn from_pattern(regex_pattern: &str, field: Field) -> Result<Self>

Creates a new RegexQuery from a given pattern

pub fn from_regex<T: Into<Arc<Regex>>>(regex: T, field: Field) -> Self

Creates a new RegexQuery from a fully built Regex

Trait Implementations

impl Clone for RegexQuery

fn clone(&self) -> RegexQuery

Returns a duplicate 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.

impl Query for RegexQuery

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

Create the weight associated with 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<'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.