Enum HighlightMode 

#[non_exhaustive]
pub enum HighlightMode {
    Whole,
    Prefix,
}

Which search produced the hit.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Whole

A hit of Searcher::search or Searcher::search_text: the whole term is aligned with the query.

Prefix

A hit of Searcher::search_prefix or Searcher::search_prefix_text: the query is aligned with the shortest prefix of the term that attains the hit’s cost, and the rest of the term is never highlighted.

Trait Implementations

impl Clone for HighlightMode

fn clone(&self) -> HighlightMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HighlightMode

impl Debug for HighlightMode

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

Formats the value using the given formatter.

impl Default for HighlightMode

fn default() -> HighlightMode

Returns the “default value” for a type.

impl Eq for HighlightMode

impl Hash for HighlightMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HighlightMode

fn eq(&self, other: &HighlightMode) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HighlightMode