Struct Style 

pub struct Style {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub effects: Effects,
}

A text style, a combination of a foreground color, a background color and text effects (all optional).

Fields

fg: Option<Color>

The foreground color (if set).

bg: Option<Color>

The background color (if set).

effects: Effects

The text effects.

Implementations

impl Style

pub fn new(fg: Option<Color>, bg: Option<Color>, effects: Effects) -> Style

Creates a new style with the given foreground and background colors and effects.

pub fn fg(color: Color) -> Style

Creates a new style with the given foreground color.

pub fn bg(color: Color) -> Style

Creates a new style with the given background color.

pub fn effect(effect: Effect) -> Style

Creates a new style with the given text effect.

pub fn effects(effects: Effects) -> Style

Creates a new style with the given text effects.

pub fn and(self, style: Style) -> Style

Combines this style with another style.

If a color is set by both styles, the current color is overwritten.

Example

use text_style::{AnsiColor, Effects, Style};

assert_eq!(
    Style::fg(AnsiColor::Red.dark()).and(Style::bg(AnsiColor::White.dark())),
    Style::new(Some(AnsiColor::Red.dark()), Some(AnsiColor::White.dark()), Effects::empty()),
);

pub fn set_fg(&mut self, color: Color)

Sets the foreground color of this style.

pub fn set_bg(&mut self, color: Color)

Sets the background color of this style.

pub fn set_bold(&mut self, bold: bool)

Sets or unsets the bold effect for this style.

pub fn set_italic(&mut self, italic: bool)

Sets or unsets the italic effect for this style.

pub fn set_underline(&mut self, underline: bool)

Sets or unsets the underline effect for this style.

pub fn strikethrough(&mut self, strikethrough: bool)

Sets or unsets the strikethrough effect for this style.

pub fn set_effect(&mut self, effect: Effect, set: bool)

Sets or unsets the given effect for this style.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate 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 From<Effect> for Style

fn from(effect: Effect) -> Style

Converts to this type from the input type.

impl From<Effects> for Style

fn from(effects: Effects) -> Style

Converts to this type from the input type.

impl From<Style> for ContentStyle

fn from(style: Style) -> ContentStyle

Converts to this type from the input type.

impl From<Style> for Style

fn from(style: Style) -> Style

Converts to this type from the input type.

impl From<Style> for Style

fn from(style: Style) -> Style

Converts to this type from the input type.

impl From<Style> for Style

fn from(s: Style) -> Style

Converts to this type from the input type.

impl From<Style> for Style

fn from(style: Style) -> Style

Converts to this type from the input type.

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

impl StructuralPartialEq for Style