Struct TextWithHighlights 

#[non_exhaustive]
pub struct TextWithHighlights {
    pub text: Option<String>,
    pub highlights: Option<Vec<Highlight>>,
}

Provides text and information about where to highlight the text.

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.

text: Option<String>

The text to display to the user.

highlights: Option<Vec<Highlight>>

The beginning and end of the text that should be highlighted.

Implementations

impl TextWithHighlights

pub fn text(&self) -> Option<&str>

The text to display to the user.

pub fn highlights(&self) -> &[Highlight]

The beginning and end of the text that should be highlighted.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .highlights.is_none().

impl TextWithHighlights

pub fn builder() -> TextWithHighlightsBuilder

Creates a new builder-style object to manufacture TextWithHighlights.

Trait Implementations

impl Clone for TextWithHighlights

fn clone(&self) -> TextWithHighlights

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextWithHighlights

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

Formats the value using the given formatter.

impl PartialEq for TextWithHighlights

fn eq(&self, other: &TextWithHighlights) -> 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 StructuralPartialEq for TextWithHighlights