Struct tantivy::SnippetGenerator

pub struct SnippetGenerator { /* private fields */ }

SnippetGenerator

Example

use tantivy::SnippetGenerator;

// ...
let query = query_parser.parse_query("haleurs flamands").unwrap();
let mut snippet_generator = SnippetGenerator::create(&searcher, &*query, text_field)?;
snippet_generator.set_max_num_chars(100);
let snippet = snippet_generator.snippet_from_doc(&doc);
let snippet_html: String = snippet.to_html();
assert_eq!(snippet_html, "Comme je descendais des Fleuves impassibles,\n  Je ne me sentis plus guidé par les <b>haleurs</b> :\n Des");

Implementations

impl SnippetGenerator

pub fn new(
    terms_text: BTreeMap<String, Score>,
    tokenizer: TextAnalyzer,
    field: Field,
    max_num_chars: usize
) -> Self

Creates a new snippet generator

pub fn create(
    searcher: &Searcher,
    query: &dyn Query,
    field: Field
) -> Result<SnippetGenerator>

Creates a new snippet generator

pub fn set_max_num_chars(&mut self, max_num_chars: usize)

Sets a maximum number of chars.

pub fn snippet_from_doc(&self, doc: &Document) -> Snippet

Generates a snippet for the given Document.

This method extract the text associated with the SnippetGenerator’s field and computes a snippet.

pub fn snippet(&self, text: &str) -> Snippet

Generates a snippet for the given text.