Enum crossterm::style::Colored

pub enum Colored {
    ForegroundColor(Color),
    BackgroundColor(Color),
    UnderlineColor(Color),
}

Represents a foreground or background color.

This can be converted to a Colors by calling into() and applied using the SetColors command.

Variants

ForegroundColor(Color)

A foreground color.

BackgroundColor(Color)

A background color.

UnderlineColor(Color)

An underline color. Imporant: doesnt work on windows 10 or lower.

Implementations

impl Colored

pub fn parse_ansi(ansi: &str) -> Option<Self>

Parse an ANSI foreground or background color. This is the string that would appear within an ESC [ <str> m escape sequence, as found in various configuration files.

Examples

use crossterm::style::{Colored::{self, ForegroundColor, BackgroundColor}, Color};

assert_eq!(Colored::parse_ansi("38;5;0"), Some(ForegroundColor(Color::Black)));
assert_eq!(Colored::parse_ansi("38;5;26"), Some(ForegroundColor(Color::AnsiValue(26))));
assert_eq!(Colored::parse_ansi("48;2;50;60;70"), Some(BackgroundColor(Color::Rgb { r: 50, g: 60, b: 70 })));
assert_eq!(Colored::parse_ansi("49"), Some(BackgroundColor(Color::Reset)));
assert_eq!(Colored::parse_ansi("invalid color"), None);

Currently, 3/4 bit color values aren’t supported so return None.

See also: Color::parse_ansi.

pub fn ansi_color_disabled() -> bool

Checks whether ansi color sequences are disabled by setting of NO_COLOR in environment as per https://no-color.org/

pub fn ansi_color_disabled_memoized() -> bool

pub fn set_ansi_color_disabled(val: bool)

Trait Implementations

impl Clone for Colored

fn clone(&self) -> Colored

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Colored

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

Formats the value using the given formatter.

impl Display for Colored

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

Formats the value using the given formatter.

impl From<Colored> for Colors

fn from(colored: Colored) -> Colors

Converts to this type from the input type.

impl Hash for Colored

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 Colored

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

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

fn partial_cmp(&self, other: &Colored) -> 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 Colored

impl Eq for Colored

impl StructuralPartialEq for Colored