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,

source

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));
source

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));
source

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>());
source

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>());
source

pub fn on_black(self) -> BgColorDisplay<'a, Black, T>

Change the background color to black

source

pub fn black(self) -> ComboColorDisplay<'a, Black, Bg, T>

Change the foreground color to black

source

pub fn on_red(self) -> BgColorDisplay<'a, Red, T>

Change the background color to red

source

pub fn red(self) -> ComboColorDisplay<'a, Red, Bg, T>

Change the foreground color to red

source

pub fn on_green(self) -> BgColorDisplay<'a, Green, T>

Change the background color to green

source

pub fn green(self) -> ComboColorDisplay<'a, Green, Bg, T>

Change the foreground color to green

source

pub fn on_yellow(self) -> BgColorDisplay<'a, Yellow, T>

Change the background color to yellow

source

pub fn yellow(self) -> ComboColorDisplay<'a, Yellow, Bg, T>

Change the foreground color to yellow

source

pub fn on_blue(self) -> BgColorDisplay<'a, Blue, T>

Change the background color to blue

source

pub fn blue(self) -> ComboColorDisplay<'a, Blue, Bg, T>

Change the foreground color to blue

source

pub fn on_magenta(self) -> BgColorDisplay<'a, Magenta, T>

Change the background color to magenta

source

pub fn magenta(self) -> ComboColorDisplay<'a, Magenta, Bg, T>

Change the foreground color to magenta

source

pub fn on_purple(self) -> BgColorDisplay<'a, Magenta, T>

Change the background color to purple

source

pub fn purple(self) -> ComboColorDisplay<'a, Magenta, Bg, T>

Change the foreground color to purple

source

pub fn on_cyan(self) -> BgColorDisplay<'a, Cyan, T>

Change the background color to cyan

source

pub fn cyan(self) -> ComboColorDisplay<'a, Cyan, Bg, T>

Change the foreground color to cyan

source

pub fn on_white(self) -> BgColorDisplay<'a, White, T>

Change the background color to white

source

pub fn white(self) -> ComboColorDisplay<'a, White, Bg, T>

Change the foreground color to white

source

pub fn on_bright_black(self) -> BgColorDisplay<'a, BrightBlack, T>

Change the background color to bright black

source

pub fn bright_black(self) -> ComboColorDisplay<'a, BrightBlack, Bg, T>

Change the foreground color to bright black

source

pub fn on_bright_red(self) -> BgColorDisplay<'a, BrightRed, T>

Change the background color to bright red

source

pub fn bright_red(self) -> ComboColorDisplay<'a, BrightRed, Bg, T>

Change the foreground color to bright red

source

pub fn on_bright_green(self) -> BgColorDisplay<'a, BrightGreen, T>

Change the background color to bright green

source

pub fn bright_green(self) -> ComboColorDisplay<'a, BrightGreen, Bg, T>

Change the foreground color to bright green

source

pub fn on_bright_yellow(self) -> BgColorDisplay<'a, BrightYellow, T>

Change the background color to bright yellow

source

pub fn bright_yellow(self) -> ComboColorDisplay<'a, BrightYellow, Bg, T>

Change the foreground color to bright yellow

source

pub fn on_bright_blue(self) -> BgColorDisplay<'a, BrightBlue, T>

Change the background color to bright blue

source

pub fn bright_blue(self) -> ComboColorDisplay<'a, BrightBlue, Bg, T>

Change the foreground color to bright blue

source

pub fn on_bright_magenta(self) -> BgColorDisplay<'a, BrightMagenta, T>

Change the background color to bright magenta

source

pub fn bright_magenta(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>

Change the foreground color to bright magenta

source

pub fn on_bright_purple(self) -> BgColorDisplay<'a, BrightMagenta, T>

Change the background color to bright purple

source

pub fn bright_purple(self) -> ComboColorDisplay<'a, BrightMagenta, Bg, T>

Change the foreground color to bright purple

source

pub fn on_bright_cyan(self) -> BgColorDisplay<'a, BrightCyan, T>

Change the background color to bright cyan

source

pub fn bright_cyan(self) -> ComboColorDisplay<'a, BrightCyan, Bg, T>

Change the foreground color to bright cyan

source

pub fn on_bright_white(self) -> BgColorDisplay<'a, BrightWhite, T>

Change the background color to bright white

source

pub fn bright_white(self) -> ComboColorDisplay<'a, BrightWhite, Bg, T>

Change the foreground color to bright white

Trait Implementations§

source§

impl<'a, Color: Color, T: Binary> Binary for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: Debug> Debug for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a, Color: Color, T: Display> Display for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a, Color: Color, T: LowerExp> LowerExp for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: LowerHex> LowerHex for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: Octal> Octal for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: Pointer> Pointer for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: UpperExp> UpperExp for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.
source§

impl<'a, Color: Color, T: UpperHex> UpperHex for BgColorDisplay<'a, Color, T>

source§

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

Formats the value using the given formatter.

Auto Trait Implementations§

§

impl<'a, C, T> Freeze for BgColorDisplay<'a, C, T>

§

impl<'a, C, T> RefUnwindSafe for BgColorDisplay<'a, C, T>

§

impl<'a, C, T> Send for BgColorDisplay<'a, C, T>
where C: Send, T: Sync,

§

impl<'a, C, T> Sync for BgColorDisplay<'a, C, T>
where C: Sync, T: Sync,

§

impl<'a, C, T> Unpin for BgColorDisplay<'a, C, T>
where C: Unpin,

§

impl<'a, C, T> UnwindSafe for BgColorDisplay<'a, C, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<D> OwoColorize for D

source§

fn fg<C: Color>(&self) -> FgColorDisplay<'_, C, Self>

Set the foreground color generically Read more
source§

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

Set the background color generically. Read more
source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text italicized
Make the text blink
Make the text blink (but fast!)
source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
source§

fn color<Color: DynColor>( &self, color: Color ) -> FgDynColorDisplay<'_, 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, Read more
source§

fn on_color<Color: DynColor>( &self, color: Color ) -> BgDynColorDisplay<'_, 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, Read more
source§

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

Set the foreground color to a specific RGB value.
source§

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

Set the background color to a specific RGB value.
source§

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

Sets the foreground color to an RGB value.
source§

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

Sets the background color to an RGB value.
source§

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

Apply a runtime-determined style
source§

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

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. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.