Struct Highlight 

pub struct Highlight {
    pub foreground: Option<Color>,
    pub background: Option<Color>,
    pub style: Vec<StyleAttribute>,
}

Highlight definition.

Contains foreground and background colors as well as the style to use.

Fields

foreground: Option<Color>

Foreground color.

Leaving it empty implies using the default foreground color of your terminal

background: Option<Color>

Background color.

Leaving it empty implies using the default background color of your terminal

style: Vec<StyleAttribute>

Style attributes to use.

Implementations

impl Highlight

pub fn highlight(&self, input: impl AsRef<str>) -> HighlightedString

Apply the highlight to an input string.

Trait Implementations

impl Debug for Highlight

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Highlight

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Highlight

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

where __S: Serializer,

Serialize this value into the given Serde serializer.