Struct Highlight 

pub struct Highlight { /* private fields */ }

Match highlighting for a Search (the highlight block). Name the fields to highlight and tune the tags / fragments; pass it to Search::highlight.

Implementations

impl Highlight

pub fn new() -> Self

An empty highlight config — add fields with field.

pub fn field(self, field: impl Into<String>) -> Self

Highlight field with the default settings.

pub fn field_with(self, field: impl Into<String>, settings: Value) -> Self

Highlight field with explicit per-field settings (e.g. a custom fragment_size / matched_fields).

pub fn pre_tags(self, tags: impl IntoIterator<Item = impl Into<String>>) -> Self

Tags wrapping each highlighted snippet’s start.

pub fn post_tags( self, tags: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Tags wrapping each highlighted snippet’s end.

pub fn fragment_size(self, fragment_size: u32) -> Self

Character length of each highlighted fragment.

pub fn number_of_fragments(self, number_of_fragments: u32) -> Self

Maximum number of fragments returned per field.

pub fn require_field_match(self, require: bool) -> Self

Only highlight fields that the query matched (default true).

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.