Enum Attribute 

#[non_exhaustive]
pub enum Attribute {
    Reset,
    Bold,
    Dim,
    Italic,
    Underlined,
    DoubleUnderlined,
    Undercurled,
    Underdotted,
    Underdashed,
    SlowBlink,
    RapidBlink,
    Reverse,
    Hidden,
    CrossedOut,
    Fraktur,
    NoBold,
    NormalIntensity,
    NoItalic,
    NoUnderline,
    NoBlink,
    NoReverse,
    NoHidden,
    NotCrossedOut,
    Framed,
    Encircled,
    OverLined,
    NotFramedOrEncircled,
    NotOverLined,
}

Available on crate feature term only.

Represents an attribute.

Platform-specific Notes

• Only UNIX and Windows 10 terminals do support text attributes.
• Keep in mind that not all terminals support all attributes.
• Crossterm implements almost all attributes listed in the SGR parameters.

Attribute	Windows	UNIX	Notes
Reset	✓	✓
Bold	✓	✓
Dim	✓	✓
Italic	?	?	Not widely supported, sometimes treated as inverse.
Underlined	✓	✓
SlowBlink	?	?	Not widely supported, sometimes treated as inverse.
RapidBlink	?	?	Not widely supported. MS-DOS ANSI.SYS; 150+ per minute.
Reverse	✓	✓
Hidden	✓	✓	Also known as Conceal.
Fraktur	✗	✓	Legible characters, but marked for deletion.
DefaultForegroundColor	?	?	Implementation specific (according to standard).
DefaultBackgroundColor	?	?	Implementation specific (according to standard).
Framed	?	?	Not widely supported.
Encircled	?	?	This should turn on the encircled attribute.
OverLined	?	?	This should draw a line at the top of the text.

Examples

Basic usage:

use crossterm::style::Attribute;

println!(
    "{} Underlined {} No Underline",
    Attribute::Underlined,
    Attribute::NoUnderline
);

Style existing text:

use crossterm::style::Stylize;

println!("{}", "Bold text".bold());
println!("{}", "Underlined text".underlined());
println!("{}", "Negative text".negative());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Reset

Resets all the attributes.

Bold

Increases the text intensity.

Dim

Decreases the text intensity.

Italic

Emphasises the text.

Underlined

Underlines the text.

DoubleUnderlined

Double underlines the text.

Undercurled

Undercurls the text.

Underdotted

Underdots the text.

Underdashed

Underdashes the text.

SlowBlink

Makes the text blinking (< 150 per minute).

RapidBlink

Makes the text blinking (>= 150 per minute).

Reverse

Swaps foreground and background colors.

Hidden

Hides the text (also known as Conceal).

CrossedOut

Crosses the text.

Fraktur

Sets the Fraktur typeface.

Mostly used for mathematical alphanumeric symbols.

NoBold

Turns off the Bold attribute. - Inconsistent - Prefer to use NormalIntensity

NormalIntensity

Switches the text back to normal intensity (no bold, italic).

NoItalic

Turns off the Italic attribute.

NoUnderline

Turns off the Underlined attribute.

NoBlink

Turns off the text blinking (SlowBlink or RapidBlink).

NoReverse

Turns off the Reverse attribute.

NoHidden

Turns off the Hidden attribute.

NotCrossedOut

Turns off the CrossedOut attribute.

Framed

Makes the text framed.

Encircled

Makes the text encircled.

OverLined

Draws a line at the top of the text.

NotFramedOrEncircled

Turns off the Frame and Encircled attributes.

NotOverLined

Turns off the OverLined attribute.

Implementations

impl Attribute

pub fn iterator() -> impl Iterator<Item = Attribute>

Iterates over all the variants of the Attribute enum.

impl Attribute

pub const fn bytes(self) -> u32

Returns a u32 with one bit set, which is the signature of this attribute in the Attributes bitset.

The +1 enables storing Reset (whose index is 0) in the bitset Attributes.

pub fn sgr(self) -> String

Returns the SGR attribute value.

See https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters

Trait Implementations

impl BitAnd<Attribute> for Attributes

type Output = Attributes

The resulting type after applying the & operator.

fn bitand(self, rhs: Attribute) -> Attributes

Performs the & operation.

impl BitOr<Attribute> for Attributes

type Output = Attributes

The resulting type after applying the | operator.

fn bitor(self, rhs: Attribute) -> Attributes

Performs the | operation.

impl BitXor<Attribute> for Attributes

type Output = Attributes

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Attribute) -> Attributes

Performs the ^ operation.

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Attribute

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Display for Attribute

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

Formats the value using the given formatter.

impl Eq for Attribute

impl From<Attribute> for Attributes

fn from(attribute: Attribute) -> Attributes

Converts to this type from the input type.

impl Hash for Attribute

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Attribute

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

Equality operator ==.

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

Inequality operator !=.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Attribute