Struct Style

pub struct Style { /* private fields */ }

Defines how to style a region of text.

Besides a main foreground Color, an optional background color and the following four booleans can be set:

• underline
• strikethrough
• italic
• bold

Instantiation

A Style can mainly be created in three ways:

• Using Style::new to specify the colors and all boolean flags explicitly.
• Using Style::color_only to specify the foreground color’s red, green, and blue values and keep all booleans disabled.
• Using the From<Color> implementation to create a Style with the given Color and all booleans disabled.

Implementations

impl Style

pub fn new( color: Color, bg: Option<Color>, underline: bool, strikethrough: bool, italic: bool, bold: bool, ) -> Self

Create a new Style.

pub fn color_only(red: u8, green: u8, blue: u8) -> Self

Create a new Style with only foreground color information attached.

The function does not accept a Color instance, but instead takes the red, green, and blue values separately to create a new color. To create a color-only Style from an existing Color instance, use the From<Color> implementation.

pub fn color(&self) -> Color

Get this Style’s foreground Color.

pub fn bg(&self) -> Option<Color>

Get this Style’s background Color.

pub fn underline(&self) -> bool

Whether this Style is underlined.

pub fn strikethrough(&self) -> bool

Whether this Style is strikethrough.

pub fn italic(&self) -> bool

Whether this Style is italic.

pub fn bold(&self) -> bool

Whether this Style is bold.

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 From<Rgb<Srgb, u8>> for Style

fn from(color: Color) -> Self

Converts to this type from the input 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 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 Eq for Style

impl StructuralPartialEq for Style