Struct HighlightOptions 

pub struct HighlightOptions {
    pub enabled: bool,
    pub start_tag: String,
    pub end_tag: String,
    pub max_length: Option<u32>,
    pub max_fragments: Option<u32>,
    pub delimiter: String,
}

Highlighting options for search results.

Fields

enabled: bool

Whether to include highlights.

start_tag: String

Start tag for highlights.

end_tag: String

End tag for highlights.

max_length: Option<u32>

Maximum length of highlighted text.

max_fragments: Option<u32>

Number of fragments to return.

delimiter: String

Fragment delimiter.

Implementations

impl HighlightOptions

pub fn enabled(self) -> Self

Enable highlighting.

pub fn tags(self, start: impl Into<String>, end: impl Into<String>) -> Self

Set highlight tags.

pub fn max_length(self, length: u32) -> Self

Set maximum text length.

pub fn max_fragments(self, count: u32) -> Self

Set maximum number of fragments.

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

Set fragment delimiter.

Trait Implementations

impl Clone for HighlightOptions

fn clone(&self) -> HighlightOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightOptions

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

Formats the value using the given formatter.

impl Default for HighlightOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HighlightOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HighlightOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HighlightOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HighlightOptions

impl StructuralPartialEq for HighlightOptions