pub struct BgColorDisplay<'a, C: Color, T>(/* private fields */);
Expand description
Transparent wrapper around a type which implements all the formatters the wrapped type does,
with the addition of changing the background color. Recommended to be constructed using
OwoColorize
.
Implementations§
source§impl<'a, Bg, T> BgColorDisplay<'a, Bg, T>where
Bg: Color,
impl<'a, Bg, T> BgColorDisplay<'a, Bg, T>where
Bg: Color,
sourcepub fn color<NewFg: DynColor>(
self,
fg: NewFg,
) -> ComboDynColorDisplay<'a, NewFg, Bg::DynEquivalent, T>
pub fn color<NewFg: DynColor>( self, fg: NewFg, ) -> ComboDynColorDisplay<'a, NewFg, Bg::DynEquivalent, T>
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));
sourcepub fn on_color<NewBg: DynColor>(
self,
bg: NewBg,
) -> BgDynColorDisplay<'a, NewBg, T>
pub fn on_color<NewBg: DynColor>( self, bg: NewBg, ) -> BgDynColorDisplay<'a, NewBg, T>
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));
sourcepub fn fg<C: Color>(self) -> ComboColorDisplay<'a, C, Bg, T>
pub fn fg<C: Color>(self) -> ComboColorDisplay<'a, C, Bg, T>
Set the foreground color generically
use owo_colors::{OwoColorize, colors::*};
println!("{}", "red foreground".fg::<Red>());
sourcepub fn bg<C: Color>(self) -> BgColorDisplay<'a, C, T>
pub fn bg<C: Color>(self) -> BgColorDisplay<'a, C, T>
Set the background color generically.
use owo_colors::{OwoColorize, colors::*};
println!("{}", "black background".bg::<Black>());
sourcepub fn on_black(self) -> BgColorDisplay<'a, Black, T>
pub fn on_black(self) -> BgColorDisplay<'a, Black, T>
Change the background color to black
sourcepub fn black(self) -> ComboColorDisplay<'a, Black, Bg, T>
pub fn black(self) -> ComboColorDisplay<'a, Black, Bg, T>
Change the foreground color to black
sourcepub fn on_red(self) -> BgColorDisplay<'a, Red, T>
pub fn on_red(self) -> BgColorDisplay<'a, Red, T>
Change the background color to red
sourcepub fn red(self) -> ComboColorDisplay<'a, Red, Bg, T>
pub fn red(self) -> ComboColorDisplay<'a, Red, Bg, T>
Change the foreground color to red
sourcepub fn on_green(self) -> BgColorDisplay<'a, Green, T>
pub fn on_green(self) -> BgColorDisplay<'a, Green, T>
Change the background color to green
sourcepub fn green(self) -> ComboColorDisplay<'a, Green, Bg, T>
pub fn green(self) -> ComboColorDisplay<'a, Green, Bg, T>
Change the foreground color to green
sourcepub fn on_yellow(self) -> BgColorDisplay<'a, Yellow, T>
pub fn on_yellow(self) -> BgColorDisplay<'a, Yellow, T>
Change the background color to yellow
sourcepub fn yellow(self) -> ComboColorDisplay<'a, Yellow, Bg, T>
pub fn yellow(self) -> ComboColorDisplay<'a, Yellow, Bg, T>
Change the foreground color to yellow
sourcepub fn on_blue(self) -> BgColorDisplay<'a, Blue, T>
pub fn on_blue(self) -> BgColorDisplay<'a, Blue, T>
Change the background color to blue
sourcepub fn blue(self) -> ComboColorDisplay<'a, Blue, Bg, T>
pub fn blue(self) -> ComboColorDisplay<'a, Blue, Bg, T>
Change the foreground color to blue
sourcepub fn on_magenta(self) -> BgColorDisplay<'a, Magenta, T>
pub fn on_magenta(self) -> BgColorDisplay<'a, Magenta, T>
Change the background color to magenta
sourcepub fn magenta(self) -> ComboColorDisplay<'a, Magenta, Bg, T>
pub fn magenta(self) -> ComboColorDisplay<'a, Magenta, Bg, T>
Change the foreground color to magenta
sourcepub fn on_purple(self) -> BgColorDisplay<'a, Magenta, T>
pub fn on_purple(self) -> BgColorDisplay<'a, Magenta, T>
Change the background color to purple
sourcepub fn purple(self) -> ComboColorDisplay<'a, Magenta, Bg, T>
pub fn purple(self) -> ComboColorDisplay<'a, Magenta, Bg, T>
Change the foreground color to purple
sourcepub fn on_cyan(self) -> BgColorDisplay<'a, Cyan, T>
pub fn on_cyan(self) -> BgColorDisplay<'a, Cyan, T>
Change the background color to cyan
sourcepub fn cyan(self) -> ComboColorDisplay<'a, Cyan, Bg, T>
pub fn cyan(self) -> ComboColorDisplay<'a, Cyan, Bg, T>
Change the foreground color to cyan
sourcepub fn on_white(self) -> BgColorDisplay<'a, White, T>
pub fn on_white(self) -> BgColorDisplay<'a, White, T>
Change the background color to white
sourcepub fn white(self) -> ComboColorDisplay<'a, White, Bg, T>
pub fn white(self) -> ComboColorDisplay<'a, White, Bg, T>
Change the foreground color to white
sourcepub fn on_bright_black(self) -> BgColorDisplay<'a, BrightBlack, T>
pub fn on_bright_black(self) -> BgColorDisplay<'a, BrightBlack, T>
Change the background color to bright black
sourcepub fn bright_black(self) -> ComboColorDisplay<'a, BrightBlack, Bg, T>
pub fn bright_black(self) -> ComboColorDisplay<'a, BrightBlack, Bg, T>
Change the foreground color to bright black
sourcepub fn on_bright_red(self) -> BgColorDisplay<'a, BrightRed, T>
pub fn on_bright_red(self) -> BgColorDisplay<'a, BrightRed, T>
Change the background color to bright red
sourcepub fn bright_red(self) -> ComboColorDisplay<'a, BrightRed, Bg, T>
pub fn bright_red(self) -> ComboColorDisplay<'a, BrightRed, Bg, T>
Change the foreground color to bright red
sourcepub fn on_bright_green(self) -> BgColorDisplay<'a, BrightGreen, T>
pub fn on_bright_green(self) -> BgColorDisplay<'a, BrightGreen, T>
Change the background color to bright green
sourcepub fn bright_green(self) -> ComboColorDisplay<'a, BrightGreen, Bg, T>
pub fn bright_green(self) -> ComboColorDisplay<'a, BrightGreen, Bg, T>
Change the foreground color to bright green
sourcepub fn on_bright_yellow(self) -> BgColorDisplay<'a, BrightYellow, T>
pub fn on_bright_yellow(self) -> BgColorDisplay<'a, BrightYellow, T>
Change the background color to bright yellow
sourcepub fn bright_yellow(self) -> ComboColorDisplay<'a, BrightYellow, Bg, T>
pub fn bright_yellow(self) -> ComboColorDisplay<'a, BrightYellow, Bg, T>
Change the foreground color to bright yellow
sourcepub fn on_bright_blue(self) -> BgColorDisplay<'a, BrightBlue, T>
pub fn on_bright_blue(self) -> BgColorDisplay<'a, BrightBlue, T>
Change the background color to bright blue
sourcepub fn bright_blue(self) -> ComboColorDisplay<'a, BrightBlue, Bg, T>
pub fn bright_blue(self) -> ComboColorDisplay<'a, BrightBlue, Bg, T>
Change the foreground color to bright blue
sourcepub fn on_bright_magenta(self) -> BgColorDisplay<'a, BrightMagenta, T>
pub fn on_bright_magenta(self) -> BgColorDisplay<'a, BrightMagenta, T>
Change the background color to bright magenta
sourcepub fn bright_magenta(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>
pub fn bright_magenta(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>
Change the foreground color to bright magenta
sourcepub fn on_bright_purple(self) -> BgColorDisplay<'a, BrightMagenta, T>
pub fn on_bright_purple(self) -> BgColorDisplay<'a, BrightMagenta, T>
Change the background color to bright purple
sourcepub fn bright_purple(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>
pub fn bright_purple(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>
Change the foreground color to bright purple
sourcepub fn on_bright_cyan(self) -> BgColorDisplay<'a, BrightCyan, T>
pub fn on_bright_cyan(self) -> BgColorDisplay<'a, BrightCyan, T>
Change the background color to bright cyan
sourcepub fn bright_cyan(self) -> ComboColorDisplay<'a, BrightCyan, Bg, T>
pub fn bright_cyan(self) -> ComboColorDisplay<'a, BrightCyan, Bg, T>
Change the foreground color to bright cyan
sourcepub fn on_bright_white(self) -> BgColorDisplay<'a, BrightWhite, T>
pub fn on_bright_white(self) -> BgColorDisplay<'a, BrightWhite, T>
Change the background color to bright white
sourcepub fn bright_white(self) -> ComboColorDisplay<'a, BrightWhite, Bg, T>
pub fn bright_white(self) -> ComboColorDisplay<'a, BrightWhite, Bg, T>
Change the foreground color to bright white
Trait Implementations§
Auto Trait Implementations§
impl<'a, C, T> Freeze for BgColorDisplay<'a, C, T>
impl<'a, C, T> RefUnwindSafe for BgColorDisplay<'a, C, T>where
T: RefUnwindSafe,
C: RefUnwindSafe,
impl<'a, C, T> Send for BgColorDisplay<'a, C, T>
impl<'a, C, T> Sync for BgColorDisplay<'a, C, T>
impl<'a, C, T> Unpin for BgColorDisplay<'a, C, T>where
C: Unpin,
impl<'a, C, T> UnwindSafe for BgColorDisplay<'a, C, T>where
T: RefUnwindSafe,
C: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<D> OwoColorize for D
impl<D> OwoColorize for D
source§fn fg<C: Color>(&self) -> FgColorDisplay<'_, C, Self>
fn fg<C: Color>(&self) -> FgColorDisplay<'_, C, Self>
source§fn bg<C: Color>(&self) -> BgColorDisplay<'_, C, Self>
fn bg<C: Color>(&self) -> BgColorDisplay<'_, C, Self>
source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
source§fn color<Color: DynColor>(
&self,
color: Color,
) -> FgDynColorDisplay<'_, Color, Self>
fn color<Color: DynColor>( &self, color: Color, ) -> FgDynColorDisplay<'_, Color, Self>
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moresource§fn on_color<Color: DynColor>(
&self,
color: Color,
) -> BgDynColorDisplay<'_, Color, Self>
fn on_color<Color: DynColor>( &self, color: Color, ) -> BgDynColorDisplay<'_, Color, Self>
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more