Struct Style

pub struct Style { /* private fields */ }

A terminal text style

Style stores two sets of Attributes: those attributes that the style enables, plus those that the style explicitly disables/turns off. The latter are relevant if you’re applying a style in the middle of text with a different style; e.g., if a text styled with "red bold" contains a substring styled with "blue not bold", you’d want to know that the bold effect should be disabled for that substring.

Implementations

impl Style

pub const fn new() -> Style

Create a new, empty style

pub const fn foreground(self, fg: Option<Color>) -> Style

Set or clear the foreground color.

Note that setting the foreground to None is different from setting it to Color::Default: if the style is applied in the middle of text with a foreground color set, None will leave the foreground color as-is while Color::Default will reset it.

pub const fn background(self, bg: Option<Color>) -> Style

Set or clear the background color

Note that setting the background to None is different from setting it to Color::Default: if the style is applied in the middle of text with a background color set, None will leave the background color as-is while Color::Default will reset it.

pub fn enabled_attributes<A: Into<AttributeSet>>(self, attrs: A) -> Style

Set the enabled attributes

pub fn disabled_attributes<A: Into<AttributeSet>>(self, attrs: A) -> Style

Set the disabled attributes

pub fn is_empty(self) -> bool

true if the style does not set any colors or attributes

pub fn is_enabled(self, attr: Attribute) -> bool

true if attr is enabled

pub fn is_disabled(self, attr: Attribute) -> bool

true if attr is explicitly disabled

pub const fn get_foreground(self) -> Option<Color>

Return the foreground color

pub const fn get_background(self) -> Option<Color>

Return the background color

pub const fn get_enabled_attributes(self) -> AttributeSet

Return the enabled attributes

pub const fn get_disabled_attributes(self) -> AttributeSet

Return the disabled attributes

pub fn patch(self, other: Style) -> Style

Combine two styles, applying the effects of other after self

pub fn enable<A: Into<AttributeSet>>(self, attrs: A) -> Style

Enable the given attribute(s)

pub fn disable<A: Into<AttributeSet>>(self, attrs: A) -> Style

Disable the given attribute(s)

pub fn bold(self) -> Style

Enable bold text

pub fn dim(self) -> Style

Enable dim text

pub fn italic(self) -> Style

Enable italic text

pub fn underline(self) -> Style

Enable underlining

pub fn blink(self) -> Style

Enable blinking

pub fn blink2(self) -> Style

Enable fast blinking

pub fn reverse(self) -> Style

Enable reverse video

pub fn conceal(self) -> Style

Enable concealed/hidden text

pub fn strike(self) -> Style

Enable strikethrough

pub fn underline2(self) -> Style

Enable double-underlining

pub fn frame(self) -> Style

Enable framed text

pub fn encircle(self) -> Style

Enable encircled text

pub fn overline(self) -> Style

Enable overlining

pub fn not_bold(self) -> Style

Disable bold text

pub fn not_dim(self) -> Style

Disable dim text

pub fn not_italic(self) -> Style

Disable italic text

pub fn not_underline(self) -> Style

Disable underlining

pub fn not_blink(self) -> Style

Disable blinking

pub fn not_blink2(self) -> Style

Disable fast blinking

pub fn not_reverse(self) -> Style

Disable reverse video

pub fn not_conceal(self) -> Style

Disable concealed/hidden text

pub fn not_strike(self) -> Style

Disable strikethrough

pub fn not_underline2(self) -> Style

Disable double-underlining

pub fn not_frame(self) -> Style

Disable framed text

pub fn not_encircle(self) -> Style

Disable encircled text

pub fn not_overline(self) -> Style

Disable overlining

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for Style

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Style

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

Formats the value using the given formatter.

impl From<Attribute> for Style

fn from(value: Attribute) -> Style

Construct a new Style that enables the given attribute

impl From<AttributeSet> for Style

fn from(value: AttributeSet) -> Style

Construct a new Style that enables the given attributes

impl From<Attributes> for Style

Available on crate feature crossterm only.

fn from(value: Attributes) -> Style

Convert a crossterm::style::Attributes to a Style

Data Loss

The following attributes are discarded during conversion:

• crossterm::style::Attribute::Undercurled
• crossterm::style::Attribute::Underdotted
• crossterm::style::Attribute::Underdashed
• crossterm::style::Attribute::Fraktur
• crossterm::style::Attribute::NoBold (because it’s dysfunctional)

impl<C: Into<Color>> From<C> for Style

fn from(value: C) -> Style

Construct a new Style using the given color as the foreground color

impl From<ContentStyle> for Style

Available on crate feature crossterm only.

fn from(value: ContentStyle) -> Style

Convert a crossterm::style::ContentStyle to a Style

Data Loss

Underline color is discarded during conversion.

The following attributes are discarded during conversion:

• crossterm::style::Attribute::Undercurled
• crossterm::style::Attribute::Underdotted
• crossterm::style::Attribute::Underdashed
• crossterm::style::Attribute::Fraktur

impl From<Style> for ContentStyle

Available on crate feature crossterm only.

fn from(value: Style) -> ContentStyle

Convert a Style to a crossterm::style::ContentStyle

Data Loss

Certain pairs of parse-style attributes are disabled by a single shared crossterm attribute. Thus, when one element of a pair occurs in the disabled attributes, the resulting ContentStyle will disable both elements of the pair.

The pairs are as follows:

• Attribute::Bold and Attribute::Dim — both disabled by crossterm::style::Attribute::NormalIntensity

• Attribute::Blink and Attribute::Blink2 — both disabled by crossterm::style::Attribute::NoBlink

• Attribute::Underline and Attribute::Underline2 — both disabled by crossterm::style::Attribute::NoUnderline

• Attribute::Frame and Attribute::Encircle — both disabled by crossterm::style::Attribute::NotFramedOrEncircled

impl From<Style> for Style

Available on crate feature anstyle only.

fn from(value: Style) -> Style

Convert a Style to an anstyle::Style

Data Loss

If the Style’s foreground or background color is Color::Default, it will be converted to None.

The following attributes will be discarded during conversion: - Attribute::Blink2 - Attribute::Frame - Attribute::Encircle - Attribute::Overline

Disabled attributes are discarded during conversion.

impl From<Style> for Style

Available on crate feature anstyle only.

fn from(value: Style) -> Style

Convert an anstyle::Style to a Style

Data Loss

Underline color is discarded during conversion.

The following effects are discarded during conversion:

• anstyle::Effects::CURLY_UNDERLINE
• anstyle::Effects::DOTTED_UNDERLINE
• anstyle::Effects::DASHED_UNDERLINE

impl From<Style> for Style

Available on crate feature ratatui only.

fn from(value: Style) -> Style

Convert a Style to a ratatui::style::Style

Data Loss

The following attributes are discarded during conversion:

• Attribute::Underline2
• Attribute::Frame
• Attribute::Encircle
• Attribute::Overline

impl From<Style> for Style

Available on crate feature ratatui only.

fn from(value: Style) -> Style

Convert a ratatui::style::Style to a Style

Data Loss

Underline color is discarded during conversion.

impl FromStr for Style

type Err = ParseStyleError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Style, ParseStyleError>

Parses a string s to return a value of this 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 ==.

const 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 Serialize for Style

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style