Enum yansi::Attribute

pub enum Attribute {
    Bold,
    Dim,
    Italic,
    Underline,
    Blink,
    RapidBlink,
    Invert,
    Conceal,
    Strike,
}

Enum representing text attributes, largely for text formatting.

Text attributes are typically applied to a Style, Color, or Painted struct via the corresponding chainable builder methods such as bold() or italic(). The returned value will apply the attribute(s) when rendered or printed.

Attributes are idempotent, so applying an attribute more than once has no more affect than applying it once.

Terminal Support

Whether an applied attribute actually has an effect on how text is rendered in a terminal depends on the terminal’s support for the attribute as well as the terminal’s configuration. Common attributes, such as bold, dim, italic, underline, and strike typically have good support and are largely reliable. Less commonly supported attributes like conceal and invert will usually be supported by “modern” terminals. Rarely supported attributes, such as blink and rapid blink, will typically have no effect when applied.

Example

use yansi::{Style, Color::Red};

/// A style with red foreground and every "common" attribute applied.
static MAD: Style = Red.bold().dim().italic().underline().strike();

Variants

Bold

Makes text bold.

Typically used via the bold() builder method.

Dim

Makes text dim.

Typically used via the dim() builder method.

Italic

Display text in italics.

Typically used via the italic() builder method.

Underline

Underline text.

Typically used via the underline() builder method.

Blink

Blink.

Typically used via the blink() builder method.

RapidBlink

Blink rapidly.

Typically used via the rapid_blink() builder method.

Invert

Invert (flip) the foreground and background colors.

Typically used via the invert() builder method.

Conceal

Conceal text.

Typically used via the conceal() builder method.

Strike

Display text with a strike through it.

Typically used via the strike() builder method.

Implementations

impl Attribute

pub const fn style(self) -> Style

Returns a Style with the attribute self enabled.

Example

use yansi::{Style, Attribute::Bold};

static EMBOLDEN: Style = Bold.style();

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl From<Attribute> for Style

fn from(attr: Attribute) -> Self

Converts to this type from the input type.

impl Hash for Attribute

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 Attribute

fn cmp(&self, other: &Attribute) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Attribute

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Attribute

impl Eq for Attribute

impl StructuralPartialEq for Attribute