Struct Highlight 

#[non_exhaustive]
pub struct Highlight {
    pub ranges: Vec<MatchRange>,
    pub aligned: MatchRange,
    pub cost: Cost,
    pub cells: usize,
}

The highlighting of one hit.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ranges: Vec<MatchRange>

The highlighted spans of the source string: sorted, disjoint, never empty and never touching (at least one character between two spans).

aligned: MatchRange

The span of the source string the query was aligned with: the whole term in HighlightMode::Whole, the matched prefix in HighlightMode::Prefix. Every range lies within it.

cost: Cost

The cost of the alignment behind the ranges: always equal to the hit’s Hit::cost.

cells: usize

Dynamic-programming cells computed (the deterministic work counter).

Trait Implementations

impl Clone for Highlight

fn clone(&self) -> Highlight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Highlight

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

Formats the value using the given formatter.

impl Default for Highlight

fn default() -> Highlight

Returns the “default value” for a type.

impl Eq for Highlight

impl PartialEq for Highlight

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Highlight