Struct BgDynColorDisplay

pub struct BgDynColorDisplay<'a, Color: DynColor, T: ?Sized>(/* private fields */);

Wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the background color. Is not recommended unless compile-time coloring is not an option.

Implementations

impl<'a, Bg: DynColor + Copy, T: ?Sized> BgDynColorDisplay<'a, Bg, T>

pub const fn new(thing: &'a T, color: Bg) -> Self

Create a new BgDynColorDisplay, from a reference to a type which implements DynColor.

This is a const function: in non-const contexts, OwoColorize::on_color may be more convenient.

Example

Usage in const contexts:

use owo_colors::{AnsiColors, BgDynColorDisplay};

const DYN_GREEN_BG_TEXT: BgDynColorDisplay<AnsiColors, str> =
   BgDynColorDisplay::new("green background (dynamic)", AnsiColors::Green);

println!("{}", DYN_GREEN_BG_TEXT);

pub fn into_styled(self) -> Styled<&'a T>

Convert self to a generic Styled.

This method erases color-related type parameters, and can be used to unify types across branches.

Example

use owo_colors::{AnsiColors, CssColors, OwoColorize};

fn is_red() -> bool {
    // ...
}

let styled_str = if is_red() {
    "hello".on_color(AnsiColors::Red).into_styled()
} else {
    "hello".on_color(CssColors::LightGoldenRodYellow).into_styled()
};

println!("{}", styled_str);

pub const 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));

pub const fn color<Fg: DynColor>( self, fg: Fg, ) -> ComboDynColorDisplay<'a, Fg, Bg, 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));

Trait Implementations

impl<'a, Color: DynColor, T: ?Sized + Binary> Binary for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + Debug> Debug for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + Display> Display for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + LowerExp> LowerExp for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + LowerHex> LowerHex for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + Octal> Octal for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + Pointer> Pointer for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + UpperExp> UpperExp for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.

impl<'a, Color: DynColor, T: ?Sized + UpperHex> UpperHex for BgDynColorDisplay<'a, Color, T>

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

Formats the value using the given formatter.