Struct Style

pub struct Style {
    pub fg_color: Option<Rgb>,
    pub bg_color: Option<Rgb>,
    pub is_bold: bool,
    pub is_italic: bool,
    pub is_underline: bool,
}

The styling applied to a given HighlightGroup.

When a field is given a None value, then that field’s value defaults to that of the theme’s default style. It was decided that only colours are to be optional, because it is exceedingly rare that an entire theme wishes to be bold, italic or underlined.

Fields

fg_color: Option<Rgb>

its foreground colour

bg_color: Option<Rgb>

its background colour

is_bold: bool

whether to bolden

is_italic: bool

whether to italicise

is_underline: bool

whether to underline

Implementations

impl Style

pub fn new() -> Self

Creates a new Style with all colour fields set to None and all boolean fields set to false, thereby creating a style whose value is identical to that of the theme’s default style (assuming that the theme’s default style also uses false for all boolean options).

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl Hash for Style

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Style

fn cmp(&self, other: &Style) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Style

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

fn partial_cmp(&self, other: &Style) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style