pub enum Attribute {
Show 28 variants 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,
}
Expand description

Attributes used for styling cell content. Reexport of crossterm’s Attributes enum. 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.
AttributeWindowsUNIXNotes
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
HiddenAlso known as Conceal.
FrakturLegible 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)§

This enum is marked as 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.

Makes the text blinking (< 150 per minute).

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.

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§

source§

impl Attribute

source

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

Iterates over all the variants of the Attribute enum.

source§

impl Attribute

source

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.

source

pub fn sgr(self) -> String

Trait Implementations§

source§

impl Clone for Attribute

source§

fn clone(&self) -> Attribute

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Attribute

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Attribute

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Attribute

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Attribute

source§

fn cmp(&self, other: &Attribute) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<Attribute> for Attribute

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd<Attribute> for Attribute

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Copy for Attribute

source§

impl Eq for Attribute

source§

impl StructuralEq for Attribute

source§

impl StructuralPartialEq for Attribute

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.