Struct MSet

pub struct MSet(/* private fields */);

A list of search results with associated metadata

Implementations

impl MSet

pub fn convert_to_percent(&self, weight: f64) -> i32

Convert a weight to a percentage, taking into account weighted query terms

pub fn empty(&self) -> bool

Detects whether this MSet is empty

pub fn matches(&self) -> MSetIter<'_>

Retrieve the iterator of Match objects for this MSet

pub fn size(&self) -> u32

The number of matches in this MSet

pub fn snippet<T, U, V>( &self, text: impl AsRef<str>, length: usize, stemmer: impl AsRef<Stem>, flags: u32, hl: impl Into<Option<(T, U)>>, omit: impl Into<Option<V>>, ) -> String

where T: AsRef<str> + Default, U: AsRef<str> + Default, V: AsRef<str> + Default,

Generate a snippet from the provided text

length controls the size of the snippet stemmer should be an instance of the same stemming algorithm used to build the query flags are used to control specific bits of functionality hl is an optional pair of string-likes used to highlight matches within the snippet, for use in markup omit is used to indicate any truncated prefix or suffix mid-sen

pub fn termfreq(&self, term: impl AsRef<str>) -> u32

Get the number of documents which term occurs in