Enum crossterm::Attribute

pub enum Attribute {
    Reset,
    Bold,
    Dim,
    Italic,
    Underlined,
    SlowBlink,
    RapidBlink,
    Reverse,
    Hidden,
    CrossedOut,
    Fraktur,
    NoBold,
    NormalIntensity,
    NoItalic,
    NoUnderline,
    NoBlink,
    NoInverse,
    NoHidden,
    NotCrossedOut,
    Framed,
    Encircled,
    OverLined,
    NotFramedOrEncircled,
    NotOverLined,
    // some variants omitted
}

Enum with the different attributes to style your test.

There are few things to note:

• Not all attributes are supported, some of them are only supported on Windows some only on Unix, and some are only very rarely supported.
• I got those attributes, descriptions, supportability from here: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters
• Take note of the fact that when running your program cross-platform that some attributes might not work because of their support.
• When an attribute is not supported nothing will happen with the terminal state.

Example

You can use an attribute in a write statement to apply the attribute to the terminal output.

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

You can also call attribute functions on a &'static str:

use Colorizer;

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

Variants

Reset

All attributes off [info]: This will reset all current set attributes. [Supportability]: Windows, UNIX.

Bold

Increased Intensity [info]: This will increase the text sensitivity also known as bold. [Supportability]: Windows, UNIX.

Dim

Decreased Intensity [info]: This will decrease the text sensitivity also known as bold. [Supportability]: Windows, UNIX.

Italic

Italic Text [info]: This will make the text italic. [Supportability]: Not widely supported, sometimes treated as inverse.

Underlined

This will draw a line under the text. [info]: An line under a word, especially in order to show its importance. [Supportability]: Windows, UNIX

SlowBlink

Slow Blinking Text [info]: Blink Less than 150 per minute. [Supportability]: UNIX

RapidBlink

Slow Blinking Text [info]: MS-DOS ANSI.SYS; 150+ per minute; [Supportability]: Not widely supported

Reverse

Swap foreground and background colors [info]: swap foreground and background colors [Supportability]: Windows, UNIX

Hidden

Hide text [info]:

• This will make the text hidden.
• Also known as 'Conceal' [Supportability]: Windows, UNIX

CrossedOut

Cross-out text [info]: Characters legible, but marked for deletion. [Supportability]: UNIX

Fraktur

The Fraktur is a typeface belonging to the group of Gothic typefaces. [info]: https://nl.wikipedia.org/wiki/Fraktur [Supportability]: Rarely supported

NoBold

This will turn off the bold attribute. [info]:

• Double-underline per ECMA-48.
• WikiPedia: https://en.wikipedia.org/wiki/Talk:ANSI_escape_code#SGR_21%E2%80%94%60Bold_off%60_not_widely_supported
• Opposite of Bold(1) [Supportability]: not widely supported

NormalIntensity

Normal color or intensity Neither bold nor faint

NoItalic

This will turn off the italic attribute. [info]:

• Not italic, not Fraktur
• Opposite of Italic(3) [Supportability]: Windows, UNIX

NoUnderline

This will turn off the underline attribute. [info]:

• Not singly or doubly underlined will be turned off.
• Opposite of Underlined.(4) [Supportability]: Windows, UNIX

NoBlink

This will turn off the blinking attribute [info]: Opposite of Slow and Rapid blink.(5,6) [Supportability]: Unknown

NoInverse

This will turn off the reverse attribute. [info]: Opposite of Reverse(7) [Supportability]: Windows, unknown

NoHidden

This will make the text visible. [info]: Opposite of Hidden(8) [Supportability]: Unknown

NotCrossedOut

This will turn off the crossed out attribute. [info]: Opposite of CrossedOut(9) [Supportability]: Not widely supported

Framed

Framed text. [Supportability]: Not widely supported

Encircled

This will turn on the encircled attribute.

OverLined

This will draw a line at the top of the text. [info]: Implementation defined (according to standard) [Supportability]: Unknown

NotFramedOrEncircled

This will turn off the framed or encircled attribute.

NotOverLined

This will turn off the overLined attribute. [info]: Opposite of OverLined(7) [Supportability]: Windows, unknown

Trait Implementations

impl PartialOrd<Attribute> for Attribute

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Ord for Attribute

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Eq for Attribute

impl Display for Attribute

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

Formats the value using the given formatter.

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<(), Error>

Formats the value using the given formatter.

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, 

Feeds a slice of this type into the given [Hasher].

impl Copy for Attribute

impl PartialEq<Attribute> for Attribute

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.