Struct mimi::Style

pub struct Style {
    pub foreground: Option<Color>,
    pub background: Option<Color>,
    pub modifiers: HashSet<Modifier>,
}

Describes the foreground color, background color, and any additional modifications (inverse, bold, etc).

Fields

foreground: Option<Color>

The color used to render the text. If None, uses whatever the terminal’s default color is.

background: Option<Color>

The color used to render the background. If None, uses whatever the terminal’s default color is.

modifiers: HashSet<Modifier>

Any extra formatting information, such as bold/italic.

Implementations

impl Style

pub fn combine(&self, other: &Style) -> Style

Combines the two styles. If other has a foreground color specified, the combined style uses that color; else, self’s color is used. The same logic applies to background colors. The modifier sets are unioned.

This operation is associative (i.e., foo.combine(bar.combine(baz)) == (foo.combine(bar)).combine(baz) but not commutative (i.e., foo.combine(bar) != bar.combine(foo)), and foo.combine(Style::default()) == Style::default().combine(foo) == foo. If you’re a math nerd, Style::combine forms a monoid.

pub fn ansi(&self) -> String

An ANSI control code sequence that will cause text to be formatted in the given style. This assumes that the old state has no foreground color, no background color, etc.

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 PartialEq<Style> for Style

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Style

impl StructuralEq for Style

impl StructuralPartialEq for Style