Trait colorz::Colorize

source ·
pub trait Colorize {
Show 100 methods // Provided methods fn into_style(self) -> StyledValue<Self> where Self: Sized { ... } fn style(&self) -> StyledValue<&Self> { ... } fn into_style_with<F, B, U>( self, style: Style<F, B, U> ) -> StyledValue<Self, F, B, U> where Self: Sized { ... } fn style_with<F, B, U>( &self, style: Style<F, B, U> ) -> StyledValue<&Self, F, B, U> { ... } fn fg<C>(&self, color: C) -> StyledValue<&Self, C> { ... } fn into_fg<C>(self, color: C) -> StyledValue<Self, C> where Self: Sized { ... } fn bg<C>(&self, color: C) -> StyledValue<&Self, NoColor, C> { ... } fn into_bg<C>(self, color: C) -> StyledValue<Self, NoColor, C> where Self: Sized { ... } fn underline_color<C>( &self, color: C ) -> StyledValue<&Self, NoColor, NoColor, C> { ... } fn into_underline_color<C>( self, color: C ) -> StyledValue<Self, NoColor, NoColor, C> where Self: Sized { ... } fn black(&self) -> StyledValue<&Self, Black> { ... } fn red(&self) -> StyledValue<&Self, Red> { ... } fn green(&self) -> StyledValue<&Self, Green> { ... } fn yellow(&self) -> StyledValue<&Self, Yellow> { ... } fn blue(&self) -> StyledValue<&Self, Blue> { ... } fn magenta(&self) -> StyledValue<&Self, Magenta> { ... } fn cyan(&self) -> StyledValue<&Self, Cyan> { ... } fn white(&self) -> StyledValue<&Self, White> { ... } fn bright_black(&self) -> StyledValue<&Self, BrightBlack> { ... } fn bright_red(&self) -> StyledValue<&Self, BrightRed> { ... } fn bright_green(&self) -> StyledValue<&Self, BrightGreen> { ... } fn bright_yellow(&self) -> StyledValue<&Self, BrightYellow> { ... } fn bright_blue(&self) -> StyledValue<&Self, BrightBlue> { ... } fn bright_magenta(&self) -> StyledValue<&Self, BrightMagenta> { ... } fn bright_cyan(&self) -> StyledValue<&Self, BrightCyan> { ... } fn bright_white(&self) -> StyledValue<&Self, BrightWhite> { ... } fn on_black(&self) -> StyledValue<&Self, NoColor, Black> { ... } fn on_red(&self) -> StyledValue<&Self, NoColor, Red> { ... } fn on_green(&self) -> StyledValue<&Self, NoColor, Green> { ... } fn on_yellow(&self) -> StyledValue<&Self, NoColor, Yellow> { ... } fn on_blue(&self) -> StyledValue<&Self, NoColor, Blue> { ... } fn on_magenta(&self) -> StyledValue<&Self, NoColor, Magenta> { ... } fn on_cyan(&self) -> StyledValue<&Self, NoColor, Cyan> { ... } fn on_white(&self) -> StyledValue<&Self, NoColor, White> { ... } fn on_bright_black(&self) -> StyledValue<&Self, NoColor, BrightBlack> { ... } fn on_bright_red(&self) -> StyledValue<&Self, NoColor, BrightRed> { ... } fn on_bright_green(&self) -> StyledValue<&Self, NoColor, BrightGreen> { ... } fn on_bright_yellow(&self) -> StyledValue<&Self, NoColor, BrightYellow> { ... } fn on_bright_blue(&self) -> StyledValue<&Self, NoColor, BrightBlue> { ... } fn on_bright_magenta(&self) -> StyledValue<&Self, NoColor, BrightMagenta> { ... } fn on_bright_cyan(&self) -> StyledValue<&Self, NoColor, BrightCyan> { ... } fn on_bright_white(&self) -> StyledValue<&Self, NoColor, BrightWhite> { ... } fn into_black(self) -> StyledValue<Self, Black> where Self: Sized { ... } fn into_red(self) -> StyledValue<Self, Red> where Self: Sized { ... } fn into_green(self) -> StyledValue<Self, Green> where Self: Sized { ... } fn into_yellow(self) -> StyledValue<Self, Yellow> where Self: Sized { ... } fn into_blue(self) -> StyledValue<Self, Blue> where Self: Sized { ... } fn into_magenta(self) -> StyledValue<Self, Magenta> where Self: Sized { ... } fn into_cyan(self) -> StyledValue<Self, Cyan> where Self: Sized { ... } fn into_white(self) -> StyledValue<Self, White> where Self: Sized { ... } fn into_bright_black(self) -> StyledValue<Self, BrightBlack> where Self: Sized { ... } fn into_bright_red(self) -> StyledValue<Self, BrightRed> where Self: Sized { ... } fn into_bright_green(self) -> StyledValue<Self, BrightGreen> where Self: Sized { ... } fn into_bright_yellow(self) -> StyledValue<Self, BrightYellow> where Self: Sized { ... } fn into_bright_blue(self) -> StyledValue<Self, BrightBlue> where Self: Sized { ... } fn into_bright_magenta(self) -> StyledValue<Self, BrightMagenta> where Self: Sized { ... } fn into_bright_cyan(self) -> StyledValue<Self, BrightCyan> where Self: Sized { ... } fn into_bright_white(self) -> StyledValue<Self, BrightWhite> where Self: Sized { ... } fn into_on_black(self) -> StyledValue<Self, NoColor, Black> where Self: Sized { ... } fn into_on_red(self) -> StyledValue<Self, NoColor, Red> where Self: Sized { ... } fn into_on_green(self) -> StyledValue<Self, NoColor, Green> where Self: Sized { ... } fn into_on_yellow(self) -> StyledValue<Self, NoColor, Yellow> where Self: Sized { ... } fn into_on_blue(self) -> StyledValue<Self, NoColor, Blue> where Self: Sized { ... } fn into_on_magenta(self) -> StyledValue<Self, NoColor, Magenta> where Self: Sized { ... } fn into_on_cyan(self) -> StyledValue<Self, NoColor, Cyan> where Self: Sized { ... } fn into_on_white(self) -> StyledValue<Self, NoColor, White> where Self: Sized { ... } fn into_on_bright_black(self) -> StyledValue<Self, NoColor, BrightBlack> where Self: Sized { ... } fn into_on_bright_red(self) -> StyledValue<Self, NoColor, BrightRed> where Self: Sized { ... } fn into_on_bright_green(self) -> StyledValue<Self, NoColor, BrightGreen> where Self: Sized { ... } fn into_on_bright_yellow(self) -> StyledValue<Self, NoColor, BrightYellow> where Self: Sized { ... } fn into_on_bright_blue(self) -> StyledValue<Self, NoColor, BrightBlue> where Self: Sized { ... } fn into_on_bright_magenta(self) -> StyledValue<Self, NoColor, BrightMagenta> where Self: Sized { ... } fn into_on_bright_cyan(self) -> StyledValue<Self, NoColor, BrightCyan> where Self: Sized { ... } fn into_on_bright_white(self) -> StyledValue<Self, NoColor, BrightWhite> where Self: Sized { ... } fn bold(&self) -> StyledValue<&Self> { ... } fn dimmed(&self) -> StyledValue<&Self> { ... } fn italics(&self) -> StyledValue<&Self> { ... } fn underline(&self) -> StyledValue<&Self> { ... } fn double_underline(&self) -> StyledValue<&Self> { ... } fn blink(&self) -> StyledValue<&Self> { ... } fn blink_fast(&self) -> StyledValue<&Self> { ... } fn reverse(&self) -> StyledValue<&Self> { ... } fn hide(&self) -> StyledValue<&Self> { ... } fn strikethrough(&self) -> StyledValue<&Self> { ... } fn overline(&self) -> StyledValue<&Self> { ... } fn superscript(&self) -> StyledValue<&Self> { ... } fn subscript(&self) -> StyledValue<&Self> { ... } fn into_bold(self) -> StyledValue<Self> where Self: Sized { ... } fn into_dimmed(self) -> StyledValue<Self> where Self: Sized { ... } fn into_italics(self) -> StyledValue<Self> where Self: Sized { ... } fn into_underline(self) -> StyledValue<Self> where Self: Sized { ... } fn into_double_underline(self) -> StyledValue<Self> where Self: Sized { ... } fn into_blink(self) -> StyledValue<Self> where Self: Sized { ... } fn into_blink_fast(self) -> StyledValue<Self> where Self: Sized { ... } fn into_reverse(self) -> StyledValue<Self> where Self: Sized { ... } fn into_hide(self) -> StyledValue<Self> where Self: Sized { ... } fn into_strikethrough(self) -> StyledValue<Self> where Self: Sized { ... } fn into_overline(self) -> StyledValue<Self> where Self: Sized { ... } fn into_superscript(self) -> StyledValue<Self> where Self: Sized { ... } fn into_subscript(self) -> StyledValue<Self> where Self: Sized { ... }
}
Expand description

An extension trait for all values which adds convenience formatting functions

Provided Methods§

source

fn into_style(self) -> StyledValue<Self>where Self: Sized,

Convert a value to a StyledValue

source

fn style(&self) -> StyledValue<&Self>

Convert a value to a StyledValue

source

fn into_style_with<F, B, U>( self, style: Style<F, B, U> ) -> StyledValue<Self, F, B, U>where Self: Sized,

Convert a value to a StyledValue and applies the given style

source

fn style_with<F, B, U>( &self, style: Style<F, B, U> ) -> StyledValue<&Self, F, B, U>

Convert a value to a StyledValue and applies the given style

source

fn fg<C>(&self, color: C) -> StyledValue<&Self, C>

Changes the foreground color

Examples found in repository?
examples/all_xterm_colors.rs (line 6)
3
4
5
6
7
8
fn main() {
    for i in 0..=255 {
        let color = XtermColor::from(i);
        println!("{:?}", color.fg(color));
    }
}
More examples
Hide additional examples
examples/dyn_colors.rs (line 9)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
fn main() {
    let mut color = AnsiColor::Red;
    println!("{}", "red".fg(color));

    color = AnsiColor::Blue;
    println!("{}", "blue".fg(color));

    let color = XtermColor::Fuchsia;
    println!("{}", "fuchsia".fg(color));

    let color = RgbColor {
        red: 141,
        green: 59,
        blue: 212,
    };
    println!("{}", "custom purple".fg(color));

    let color = match random_number() {
        1 => Color::Rgb(colorz::rgb::RgbColor {
            red: 141,
            green: 59,
            blue: 212,
        }),
        2 => Color::Ansi(AnsiColor::BrightGreen),
        3 => "#F3F3F3".parse().unwrap(),
        _ => Color::Xterm(XtermColor::Aqua),
    };

    println!("{}", "mystery color".fg(color));
}
examples/colors.rs (line 11)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn into_fg<C>(self, color: C) -> StyledValue<Self, C>where Self: Sized,

Changes the foreground color

source

fn bg<C>(&self, color: C) -> StyledValue<&Self, NoColor, C>

Changes the background color

source

fn into_bg<C>(self, color: C) -> StyledValue<Self, NoColor, C>where Self: Sized,

Changes the background color

source

fn underline_color<C>( &self, color: C ) -> StyledValue<&Self, NoColor, NoColor, C>

Changes the underline color

source

fn into_underline_color<C>( self, color: C ) -> StyledValue<Self, NoColor, NoColor, C>where Self: Sized,

Changes the underline color

source

fn black(&self) -> StyledValue<&Self, Black>

Changes the foreground to black

Examples found in repository?
examples/colors.rs (line 8)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn red(&self) -> StyledValue<&Self, Red>

Changes the foreground to red

Examples found in repository?
examples/basic.rs (line 4)
3
4
5
fn main() {
    println!("Wow this {} {}", "is so red".red(), "and green".on_green());
}
More examples
Hide additional examples
examples/colors.rs (line 37)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn green(&self) -> StyledValue<&Self, Green>

Changes the foreground to green

Examples found in repository?
examples/colors.rs (line 5)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn yellow(&self) -> StyledValue<&Self, Yellow>

Changes the foreground to yellow

Examples found in repository?
examples/colors.rs (line 6)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn blue(&self) -> StyledValue<&Self, Blue>

Changes the foreground to blue

Examples found in repository?
examples/colors.rs (line 7)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
More examples
Hide additional examples
examples/mode.rs (line 34)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
fn main() {
    // NOTE: this example uses `stream(Stderr)` even though it's writing
    // to stdout to make it easier to see how `mode::Mode::Detect` works
    // try running this command wihtout redirecting stderr and while
    // redirecting stderr to `/dev/null` (or some file) to see how it
    // colors things differently
    //
    // ```
    // cargo run --example mode
    // cargo run --example mode 2> /dev/null
    //
    // cargo run --example mode --features strip-colors
    // cargo run --example mode --features strip-colors 2> /dev/null
    // ```
    //
    // NOTE: that colorz currently uses `std::io::IsTerminal` to detect
    // if stdin/stderr/stdout have been redirected

    assert_eq!(mode::get_default_stream(), AlwaysColor);

    mode::set_default_stream(Stderr);

    assert_eq!(mode::get_default_stream(), Stderr);

    #[cfg(feature = "std")]
    {
        mode::set_coloring_mode_from_env();
        println!("{}", "blue stderr".blue());
        println!("{}", "blue stdout".blue().stream(Stdout));
        println!("{}", "blue always".blue().stream(AlwaysColor));
        println!("{}", "blue never".blue().stream(NeverColor));
    }

    println!("color mode=always");
    mode::set_coloring_mode(mode::Mode::Always);
    println!("{}", "blue stderr".blue());
    println!("{}", "blue stdout".blue().stream(Stdout));
    println!("{}", "blue always".blue().stream(AlwaysColor));
    println!("{}", "blue never".blue().stream(NeverColor));

    println!("color mode=detect");
    mode::set_coloring_mode(mode::Mode::Detect);
    println!("{}", "blue stderr".blue());
    println!("{}", "blue stdout".blue().stream(Stdout));
    println!("{}", "blue always".blue().stream(AlwaysColor));
    println!("{}", "blue never".blue().stream(NeverColor));

    println!("color mode=never");
    mode::set_coloring_mode(mode::Mode::Never);
    println!("{}", "blue stderr".blue());
    println!("{}", "blue stdout".blue().stream(Stdout));
    println!("{}", "blue always".blue().stream(AlwaysColor));
    println!("{}", "blue never".blue().stream(NeverColor));
}
source

fn magenta(&self) -> StyledValue<&Self, Magenta>

Changes the foreground to magenta

source

fn cyan(&self) -> StyledValue<&Self, Cyan>

Changes the foreground to cyan

source

fn white(&self) -> StyledValue<&Self, White>

Changes the foreground to white

source

fn bright_black(&self) -> StyledValue<&Self, BrightBlack>

Changes the foreground to bright black

source

fn bright_red(&self) -> StyledValue<&Self, BrightRed>

Changes the foreground to bright red

source

fn bright_green(&self) -> StyledValue<&Self, BrightGreen>

Changes the foreground to bright green

source

fn bright_yellow(&self) -> StyledValue<&Self, BrightYellow>

Changes the foreground to bright yellow

source

fn bright_blue(&self) -> StyledValue<&Self, BrightBlue>

Changes the foreground to bright blue

source

fn bright_magenta(&self) -> StyledValue<&Self, BrightMagenta>

Changes the foreground to bright magenta

source

fn bright_cyan(&self) -> StyledValue<&Self, BrightCyan>

Changes the foreground to bright cyan

source

fn bright_white(&self) -> StyledValue<&Self, BrightWhite>

Changes the foreground to bright white

source

fn on_black(&self) -> StyledValue<&Self, NoColor, Black>

Changes the background to black

source

fn on_red(&self) -> StyledValue<&Self, NoColor, Red>

Changes the background to red

source

fn on_green(&self) -> StyledValue<&Self, NoColor, Green>

Changes the background to green

Examples found in repository?
examples/basic.rs (line 4)
3
4
5
fn main() {
    println!("Wow this {} {}", "is so red".red(), "and green".on_green());
}
source

fn on_yellow(&self) -> StyledValue<&Self, NoColor, Yellow>

Changes the background to yellow

source

fn on_blue(&self) -> StyledValue<&Self, NoColor, Blue>

Changes the background to blue

source

fn on_magenta(&self) -> StyledValue<&Self, NoColor, Magenta>

Changes the background to magenta

source

fn on_cyan(&self) -> StyledValue<&Self, NoColor, Cyan>

Changes the background to cyan

source

fn on_white(&self) -> StyledValue<&Self, NoColor, White>

Changes the background to white

source

fn on_bright_black(&self) -> StyledValue<&Self, NoColor, BrightBlack>

Changes the background to bright black

source

fn on_bright_red(&self) -> StyledValue<&Self, NoColor, BrightRed>

Changes the background to bright red

source

fn on_bright_green(&self) -> StyledValue<&Self, NoColor, BrightGreen>

Changes the background to bright green

source

fn on_bright_yellow(&self) -> StyledValue<&Self, NoColor, BrightYellow>

Changes the background to bright yellow

source

fn on_bright_blue(&self) -> StyledValue<&Self, NoColor, BrightBlue>

Changes the background to bright blue

source

fn on_bright_magenta(&self) -> StyledValue<&Self, NoColor, BrightMagenta>

Changes the background to bright magenta

source

fn on_bright_cyan(&self) -> StyledValue<&Self, NoColor, BrightCyan>

Changes the background to bright cyan

source

fn on_bright_white(&self) -> StyledValue<&Self, NoColor, BrightWhite>

Changes the background to bright white

source

fn into_black(self) -> StyledValue<Self, Black>where Self: Sized,

Changes the foreground to black

source

fn into_red(self) -> StyledValue<Self, Red>where Self: Sized,

Changes the foreground to red

source

fn into_green(self) -> StyledValue<Self, Green>where Self: Sized,

Changes the foreground to green

source

fn into_yellow(self) -> StyledValue<Self, Yellow>where Self: Sized,

Changes the foreground to yellow

source

fn into_blue(self) -> StyledValue<Self, Blue>where Self: Sized,

Changes the foreground to blue

source

fn into_magenta(self) -> StyledValue<Self, Magenta>where Self: Sized,

Changes the foreground to magenta

source

fn into_cyan(self) -> StyledValue<Self, Cyan>where Self: Sized,

Changes the foreground to cyan

source

fn into_white(self) -> StyledValue<Self, White>where Self: Sized,

Changes the foreground to white

source

fn into_bright_black(self) -> StyledValue<Self, BrightBlack>where Self: Sized,

Changes the foreground to bright black

source

fn into_bright_red(self) -> StyledValue<Self, BrightRed>where Self: Sized,

Changes the foreground to bright red

source

fn into_bright_green(self) -> StyledValue<Self, BrightGreen>where Self: Sized,

Changes the foreground to bright green

source

fn into_bright_yellow(self) -> StyledValue<Self, BrightYellow>where Self: Sized,

Changes the foreground to bright yellow

source

fn into_bright_blue(self) -> StyledValue<Self, BrightBlue>where Self: Sized,

Changes the foreground to bright blue

source

fn into_bright_magenta(self) -> StyledValue<Self, BrightMagenta>where Self: Sized,

Changes the foreground to bright magenta

source

fn into_bright_cyan(self) -> StyledValue<Self, BrightCyan>where Self: Sized,

Changes the foreground to bright cyan

source

fn into_bright_white(self) -> StyledValue<Self, BrightWhite>where Self: Sized,

Changes the foreground to bright white

source

fn into_on_black(self) -> StyledValue<Self, NoColor, Black>where Self: Sized,

Changes the background to black

source

fn into_on_red(self) -> StyledValue<Self, NoColor, Red>where Self: Sized,

Changes the background to red

source

fn into_on_green(self) -> StyledValue<Self, NoColor, Green>where Self: Sized,

Changes the background to green

source

fn into_on_yellow(self) -> StyledValue<Self, NoColor, Yellow>where Self: Sized,

Changes the background to yellow

source

fn into_on_blue(self) -> StyledValue<Self, NoColor, Blue>where Self: Sized,

Changes the background to blue

source

fn into_on_magenta(self) -> StyledValue<Self, NoColor, Magenta>where Self: Sized,

Changes the background to magenta

source

fn into_on_cyan(self) -> StyledValue<Self, NoColor, Cyan>where Self: Sized,

Changes the background to cyan

source

fn into_on_white(self) -> StyledValue<Self, NoColor, White>where Self: Sized,

Changes the background to white

source

fn into_on_bright_black(self) -> StyledValue<Self, NoColor, BrightBlack>where Self: Sized,

Changes the background to bright black

source

fn into_on_bright_red(self) -> StyledValue<Self, NoColor, BrightRed>where Self: Sized,

Changes the background to bright red

source

fn into_on_bright_green(self) -> StyledValue<Self, NoColor, BrightGreen>where Self: Sized,

Changes the background to bright green

source

fn into_on_bright_yellow(self) -> StyledValue<Self, NoColor, BrightYellow>where Self: Sized,

Changes the background to bright yellow

source

fn into_on_bright_blue(self) -> StyledValue<Self, NoColor, BrightBlue>where Self: Sized,

Changes the background to bright blue

source

fn into_on_bright_magenta(self) -> StyledValue<Self, NoColor, BrightMagenta>where Self: Sized,

Changes the background to bright magenta

source

fn into_on_bright_cyan(self) -> StyledValue<Self, NoColor, BrightCyan>where Self: Sized,

Changes the background to bright cyan

source

fn into_on_bright_white(self) -> StyledValue<Self, NoColor, BrightWhite>where Self: Sized,

Changes the background to bright white

source

fn bold(&self) -> StyledValue<&Self>

Applies the bold effect

Examples found in repository?
examples/colors.rs (line 28)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn dimmed(&self) -> StyledValue<&Self>

Applies the dimmed effect

source

fn italics(&self) -> StyledValue<&Self>

Applies the italics effect

Examples found in repository?
examples/colors.rs (line 29)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn underline(&self) -> StyledValue<&Self>

Applies the underline effect

Examples found in repository?
examples/colors.rs (line 27)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn double_underline(&self) -> StyledValue<&Self>

Applies the double underline effect

Applies the blink effect

Examples found in repository?
examples/colors.rs (line 33)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}

Applies the blink fast effect

Examples found in repository?
examples/colors.rs (line 34)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn reverse(&self) -> StyledValue<&Self>

Applies the reverse effect

Examples found in repository?
examples/colors.rs (line 31)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn hide(&self) -> StyledValue<&Self>

Applies the hide effect

Examples found in repository?
examples/colors.rs (line 32)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn strikethrough(&self) -> StyledValue<&Self>

Applies the strikethrough effect

Examples found in repository?
examples/colors.rs (line 30)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
fn main() {
    // normal usage
    println!("{}", "green".green());
    println!("{}", "yellow".yellow());
    println!("{}", "blue".blue());
    println!("{}", "black".black());

    // generic examples
    println!("{}", "red".fg(Red));
    println!("{}", "magenta".fg(Magenta));
    println!("{}", "white".fg(White));
    println!("{}", "cyan".fg(Cyan));

    println!("\nBrights\n-------");
    println!("{}", "green".fg(BrightGreen));
    println!("{}", "yellow".fg(BrightYellow));
    println!("{}", "blue".fg(BrightBlue));
    println!("{}", "black".fg(BrightBlack));
    println!("{}", "red".fg(BrightRed));
    println!("{}", "magenta".fg(BrightMagenta));
    println!("{}", "white".fg(BrightWhite));
    println!("{}", "cyan".fg(BrightCyan));

    println!("\nStyles\n-------");
    println!("{}", "underline".underline());
    println!("{}", "bold".bold());
    println!("{}", "italic".italics());
    println!("{}", "strikethrough".strikethrough());
    println!("{}", "reverse".reverse());
    println!("1{}3", "2".hide());
    println!("{}", "blink".blink());
    println!("{}", "blink fast".blink_fast());

    // foreground and background
    let red_on_white = "red on white".red().on_white();
    println!("{}", red_on_white);
}
source

fn overline(&self) -> StyledValue<&Self>

Applies the overline effect

source

fn superscript(&self) -> StyledValue<&Self>

Applies the superscript effect

source

fn subscript(&self) -> StyledValue<&Self>

Applies the subscript effect

source

fn into_bold(self) -> StyledValue<Self>where Self: Sized,

Applies the bold effect

source

fn into_dimmed(self) -> StyledValue<Self>where Self: Sized,

Applies the dimmed effect

source

fn into_italics(self) -> StyledValue<Self>where Self: Sized,

Applies the italics effect

source

fn into_underline(self) -> StyledValue<Self>where Self: Sized,

Applies the underline effect

source

fn into_double_underline(self) -> StyledValue<Self>where Self: Sized,

Applies the double underline effect

Applies the blink effect

Applies the blink fast effect

source

fn into_reverse(self) -> StyledValue<Self>where Self: Sized,

Applies the reverse effect

source

fn into_hide(self) -> StyledValue<Self>where Self: Sized,

Applies the hide effect

source

fn into_strikethrough(self) -> StyledValue<Self>where Self: Sized,

Applies the strikethrough effect

source

fn into_overline(self) -> StyledValue<Self>where Self: Sized,

Applies the overline effect

source

fn into_superscript(self) -> StyledValue<Self>where Self: Sized,

Applies the superscript effect

source

fn into_subscript(self) -> StyledValue<Self>where Self: Sized,

Applies the subscript effect

Implementors§

source§

impl<T: ?Sized> Colorize for T