Enum Color 

pub enum Color {
    Any,
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
    BlackBright,
    RedBright,
    GreenBright,
    YellowBright,
    BlueBright,
    MagentaBright,
    CyanBright,
    WhiteBright,
    Ansi256(u8),
    RGB(u8, u8, u8),
}

The Color enumeration can be used to directly add color in ANSI compatible environments without the use of the Style struct.

Variants

Any

A generic color

Black

A black text color

Red

A red text color

Green

A green text color

Yellow

A yellow text color

Blue

A blue text color

Magenta

A magenta text color

Cyan

A cyan text color

White

A white text color

BlackBright

A bright black (gray) text color

RedBright

A bright red text color

GreenBright

A bright green text color

YellowBright

A bright yellow text color

BlueBright

A bright blue text color

MagentaBright

A bright magenta text color

CyanBright

A bright cyan text color

WhiteBright

A bright white text color

Ansi256(u8)

An 8-bit color from 0 to 255

RGB(u8, u8, u8)

A 24-bit RGB color, as specified by ISO-8613-3.

Implementations

impl Color

pub fn close(&self) -> &'static str

Closes the terminal from adding selected color to text

Examples found in repository

examples/console.rs (line 8)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

pub fn open(&self) -> String

Opens the terminal for adding selected color to text

Examples found in repository

examples/console.rs (line 7)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

pub fn paint(&self, text: &str) -> String

Adds color to a given text

• text - the string of characters to add background color to

Examples found in repository

examples/console.rs (line 20)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Display for Color

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

Formats the value using the given formatter.

impl Ord for Color

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

impl PartialEq for Color

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Color

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

impl Eq for Color

impl StructuralPartialEq for Color