owo_colors

Struct BgColorDisplay

Source
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::DynEquivelant, 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. Read more
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. Read more
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. Read more
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. Read more
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. Read more
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. Read more
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. Read more

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 T: Sync, C: Send,

§

impl<'a, C, T> Sync for BgColorDisplay<'a, C, T>
where T: Sync, C: 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<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black
Source§

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

Change the background color to black
Source§

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

Change the foreground color to red
Source§

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

Change the background color to red
Source§

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

Change the foreground color to green
Source§

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

Change the background color to green
Source§

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

Change the foreground color to yellow
Source§

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

Change the background color to yellow
Source§

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

Change the foreground color to blue
Source§

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

Change the background color to blue
Source§

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

Change the foreground color to magenta
Source§

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

Change the background color to magenta
Source§

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

Change the foreground color to purple
Source§

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

Change the background color to purple
Source§

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

Change the foreground color to cyan
Source§

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

Change the background color to cyan
Source§

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

Change the foreground color to white
Source§

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

Change the background color to white
Source§

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

Change the foreground color to the terminal default
Source§

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

Change the background color to the terminal default
Source§

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

Change the foreground color to bright black
Source§

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

Change the background color to bright black
Source§

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

Change the foreground color to bright red
Source§

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

Change the background color to bright red
Source§

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

Change the foreground color to bright green
Source§

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

Change the background color to bright green
Source§

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

Change the foreground color to bright yellow
Source§

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

Change the background color to bright yellow
Source§

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

Change the foreground color to bright blue
Source§

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

Change the background color to bright blue
Source§

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

Change the foreground color to bright magenta
Source§

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

Change the background color to bright magenta
Source§

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

Change the foreground color to bright purple
Source§

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

Change the background color to bright purple
Source§

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

Change the foreground color to bright cyan
Source§

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

Change the background color to bright cyan
Source§

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

Change the foreground color to bright white
Source§

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

Change the background color to bright white
Source§

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

Make the text bold
Source§

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

Make the text dim
Source§

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

Make the text italicized
Source§

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

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

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

Swap the foreground and background colors
Source§

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

Hide the text
Source§

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, 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: 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>,

Source§

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>,

Source§

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.