Trait owo_colors::OwoColorize[−][src]

pub trait OwoColorize: Sized {

Show 57 methods    fn fg<C: Color>(&self) -> FgColorDisplay<'_, C, Self> { ... }

    fn bg<C: Color>(&self) -> BgColorDisplay<'_, C, Self> { ... }

    fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self> { ... }

    fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self> { ... }

    fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self> { ... }

    fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self> { ... }

    fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self> { ... }

    fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self> { ... }

    fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self> { ... }

    fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self> { ... }

    fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self> { ... }

    fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self> { ... }

    fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self> { ... }

    fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self> { ... }

    fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self> { ... }

    fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self> { ... }

    fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self> { ... }

    fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self> { ... }

    fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self> { ... }

    fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self> { ... }

    fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self> { ... }

    fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self> { ... }

    fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self> { ... }

    fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self> { ... }

    fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self> { ... }

    fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self> { ... }

    fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self> { ... }

    fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self> { ... }

    fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self> { ... }

    fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self> { ... }

    fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self> { ... }

    fn on_bright_magenta<'a>(
        &'a self
    ) -> BgColorDisplay<'a, BrightMagenta, Self> { ... }

    fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self> { ... }

    fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self> { ... }

    fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self> { ... }

    fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self> { ... }

    fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self> { ... }

    fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self> { ... }

    fn bold<'a>(&'a self) -> BoldDisplay<'a, Self> { ... }

    fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self> { ... }

    fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self> { ... }

    fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self> { ... }

    fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self> { ... }

    fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self> { ... }

    fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self> { ... }

    fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self> { ... }

    fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self> { ... }

    fn color<Color: DynColor>(
        &self, 
        color: Color
    ) -> FgDynColorDisplay<'_, Color, Self> { ... }

    fn on_color<Color: DynColor>(
        &self, 
        color: Color
    ) -> BgDynColorDisplay<'_, Color, Self> { ... }

    fn fg_rgb<const R: u8, const G: u8, const B: u8>(
        &self
    ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self> { ... }

    fn bg_rgb<const R: u8, const G: u8, const B: u8>(
        &self
    ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self> { ... }

    fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self> { ... }

    fn on_truecolor(
        &self, 
        r: u8, 
        g: u8, 
        b: u8
    ) -> BgDynColorDisplay<'_, Rgb, Self> { ... }

    fn style(&self, style: Style) -> Styled<&Self> { ... }

    fn if_stdout_tty<'a, Out, ApplyFn>(
        &'a self, 
        apply: ApplyFn
    ) -> TtyDisplay<'a, StdOut, Self, Out, ApplyFn>
    where
        ApplyFn: Fn(&'a Self) -> Out,
    { ... }

    fn if_stderr_tty<'a, Out, ApplyFn>(
        &'a self, 
        apply: ApplyFn
    ) -> TtyDisplay<'a, StdErr, Self, Out, ApplyFn>
    where
        ApplyFn: Fn(&'a Self) -> Out,
    { ... }

    fn if_supports_color<'a, Out, ApplyFn>(
        &'a self, 
        stream: Stream, 
        apply: ApplyFn
    ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
    where
        ApplyFn: Fn(&'a Self) -> Out,
    { ... }

}
Expand description

Extension trait for colorizing a type which implements any std formatter (Display, Debug, UpperHex, etc.)

Example

use owo_colors::OwoColorize;

println!("My number is {:#x}!", 10.green());
println!("My number is not {}!", 4.on_red());

How to decide which method to use

Do you have a specific color you want to use?

Use the specific color’s method, such as blue or on_green.

Do you want your colors configurable via generics?

Use fg and bg to make it compile-time configurable.

Do you need to pick a color at runtime?

Use the color, on_color, truecolor or on_truecolor.

Do you need some other text modifier?

Do you want it to only display colors if it’s a terminal?

  1. Enable the tty feature
  2. Colorize inside if_stdout_tty or if_stdout_tty

Provided methods

Set the foreground color generically

use owo_colors::{OwoColorize, colors::*};

println!("{}", "red foreground".fg::<Red>());

Set the background color generically.

use owo_colors::{OwoColorize, colors::*};

println!("{}", "black background".bg::<Black>());

Change the foreground color to black

Change the foreground color to black

Change the foreground color to red

Change the foreground color to red

Change the foreground color to green

Change the foreground color to green

Change the foreground color to yellow

Change the foreground color to yellow

Change the foreground color to blue

Change the foreground color to blue

Change the foreground color to magenta

Change the foreground color to magenta

Change the foreground color to purple

Change the foreground color to purple

Change the foreground color to cyan

Change the foreground color to cyan

Change the foreground color to white

Change the foreground color to white

Change the foreground color to bright black

Change the foreground color to bright black

Change the foreground color to bright red

Change the foreground color to bright red

Change the foreground color to bright green

Change the foreground color to bright green

Change the foreground color to bright yellow

Change the foreground color to bright yellow

Change the foreground color to bright blue

Change the foreground color to bright blue

Change the foreground color to bright magenta

Change the foreground color to bright magenta

Change the foreground color to bright purple

Change the foreground color to bright purple

Change the foreground color to bright cyan

Change the foreground color to bright cyan

Change the foreground color to bright white

Change the foreground color to bright white

Make the text bold

Make the text dim

Make the text italicized

Make the text italicized

Make the text blink

Make the text blink (but fast!)

Swap the foreground and background colors

Hide the text

Cross out the text

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green,

use owo_colors::{OwoColorize, AnsiColors};

println!("{}", "green".color(AnsiColors::Green));

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow,

use owo_colors::{OwoColorize, AnsiColors};

println!("{}", "yellow background".on_color(AnsiColors::BrightYellow));

Set the foreground color to a specific RGB value.

Set the background color to a specific RGB value.

Sets the foreground color to an RGB value.

Sets the background color to an RGB value.

Apply a runtime-determined style

👎 Deprecated since 2.1.0:

if_stdout_tty is superseded by if_supports_color

Apply a given transformation function to all formatters if stdout is a tty console allowing you to conditionally apply given styles/colors.

Requires the tty feature.

use owo_colors::{OwoColorize, Style};

fn main() {
    println!(
        "{}",
        "bright cyan if this is terminal output"
            .if_stdout_tty(|text| text.bright_cyan())
    );

    // applying multiple at both
    println!(
        "{}",
        "bright cyan AND underlined(?!) if this is terminal output"
            .if_stdout_tty(|text| text.style(
                Style::new()
                    .bright_cyan()
                    .underline()
            ))
    );
}
👎 Deprecated since 2.1.0:

if_stderr_tty is superseded by if_supports_color

Apply a given transformation function to all formatters if stderr is a tty console allowing you to conditionally apply given styles/colors.

Requires the tty feature.

use owo_colors::OwoColorize;

fn main() {
    eprintln!(
        "{}",
        "woah! error! if this is terminal output, it's red"
            .if_stderr_tty(|text| text.bright_red())
    );
}

Apply a given transformation function to all formatters if the given stream supports at least basic ANSI colors, allowing you to conditionally apply given styles/colors.

Requires the supports-colors feature.

use owo_colors::{OwoColorize, Stream};

println!(
    "{}",
    "woah! error! if this terminal supports colors, it's blue"
        .if_supports_color(Stream::Stdout, |text| text.bright_blue())
);

Implementors