[−][src]Trait owo_colors::OwoColorize
Extension trait for colorizing a type which implements any std formatter
(Display
, Debug
, UpperHex
,
etc.)
Example
use owo_colors::OwoColorize; fn main() { 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?
Provided methods
pub fn fg<'a, C: Color>(&'a self) -> FgColorDisplay<'a, C, Self>
[src]
Set the foreground color generically
use owo_colors::{OwoColorize, colors::*}; println!("{}", "red foreground".fg::<Red>());
pub fn bg<'a, C: Color>(&'a self) -> BgColorDisplay<'a, C, Self>
[src]
Set the background color generically.
use owo_colors::{OwoColorize, colors::*}; println!("{}", "black background".bg::<Black>());
pub fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>
[src]
Change the foreground color to black
pub fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>
[src]
Change the foreground color to black
pub fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>
[src]
Change the foreground color to red
pub fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>
[src]
Change the foreground color to red
pub fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>
[src]
Change the foreground color to green
pub fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>
[src]
Change the foreground color to green
pub fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>
[src]
Change the foreground color to yellow
pub fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>
[src]
Change the foreground color to yellow
pub fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>
[src]
Change the foreground color to blue
pub fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>
[src]
Change the foreground color to blue
pub fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
[src]
Change the foreground color to magenta
pub fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
[src]
Change the foreground color to magenta
pub fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>
[src]
Change the foreground color to purple
pub fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>
[src]
Change the foreground color to purple
pub fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>
[src]
Change the foreground color to cyan
pub fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>
[src]
Change the foreground color to cyan
pub fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>
[src]
Change the foreground color to white
pub fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>
[src]
Change the foreground color to white
pub fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>
[src]
Change the foreground color to bright black
pub fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>
[src]
Change the foreground color to bright black
pub fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>
[src]
Change the foreground color to bright red
pub fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>
[src]
Change the foreground color to bright red
pub fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>
[src]
Change the foreground color to bright green
pub fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>
[src]
Change the foreground color to bright green
pub fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>
[src]
Change the foreground color to bright yellow
pub fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>
[src]
Change the foreground color to bright yellow
pub fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>
[src]
Change the foreground color to bright blue
pub fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>
[src]
Change the foreground color to bright blue
pub fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
[src]
Change the foreground color to bright magenta
pub fn on_bright_magenta<'a>(
&'a self
) -> BgColorDisplay<'a, BrightMagenta, Self>
[src]
&'a self
) -> BgColorDisplay<'a, BrightMagenta, Self>
Change the foreground color to bright magenta
pub fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>
[src]
Change the foreground color to bright purple
pub fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>
[src]
Change the foreground color to bright purple
pub fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>
[src]
Change the foreground color to bright cyan
pub fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>
[src]
Change the foreground color to bright cyan
pub fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>
[src]
Change the foreground color to bright white
pub fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>
[src]
Change the foreground color to bright white
pub fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>
[src]
Make the text bold
pub fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>
[src]
Make the text dim
pub fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>
[src]
Make the text italicized
pub fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>
[src]
Make the text italicized
pub fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>
[src]
Make the text blink
pub fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>
[src]
Make the text blink (but fast!)
pub fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>
[src]
Swap the foreground and background colors
pub fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>
[src]
Hide the text
pub fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>
[src]
Cross out the text
pub fn color<'a, Color: DynColor>(
&'a self,
color: Color
) -> FgDynColorDisplay<'a, Color, Self>
[src]
&'a self,
color: Color
) -> FgDynColorDisplay<'a, Color, Self>
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}; fn main() { println!("{}", "green".color(AnsiColors::Green)); }
pub fn on_color<'a, Color: DynColor>(
&'a self,
color: Color
) -> BgDynColorDisplay<'a, Color, Self>
[src]
&'a self,
color: Color
) -> BgDynColorDisplay<'a, Color, Self>
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}; fn main() { println!("{}", "yellow background".on_color(AnsiColors::BrightYellow)); }
pub fn fg_rgb<'a, const R: u8, const G: u8, const B: u8>(
&'a self
) -> FgColorDisplay<'a, CustomColor<R, G, B>, Self>
[src]
&'a self
) -> FgColorDisplay<'a, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
Requires: nightly and the custom
feature.
If nightly is not preferable for you, use OwoColorize::truecolor
pub fn bg_rgb<'a, const R: u8, const G: u8, const B: u8>(
&'a self
) -> BgColorDisplay<'a, CustomColor<R, G, B>, Self>
[src]
&'a self
) -> BgColorDisplay<'a, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
Requires: nightly and the custom
feature.
If nightly is not preferable for you, use OwoColorize::on_truecolor
pub fn truecolor<'a>(
&'a self,
r: u8,
g: u8,
b: u8
) -> FgDynColorDisplay<'a, Rgb, Self>
[src]
&'a self,
r: u8,
g: u8,
b: u8
) -> FgDynColorDisplay<'a, Rgb, Self>
Sets the foreground color to an RGB value.
pub fn on_truecolor<'a>(
&'a self,
r: u8,
g: u8,
b: u8
) -> BgDynColorDisplay<'a, Rgb, Self>
[src]
&'a self,
r: u8,
g: u8,
b: u8
) -> BgDynColorDisplay<'a, Rgb, Self>
Sets the background color to an RGB value.