Struct ComboDynColorDisplay

pub struct ComboDynColorDisplay<'a, Fg, Bg, T>(/* private fields */)
where
    Fg: DynColor,
    Bg: DynColor,
    T: ?Sized;

Wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the foreground and background color.

If compile-time coloring is an option, consider using ComboColorDisplay instead.

Implementations

impl<'a, Fg, Bg, T> ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor + Copy, Bg: DynColor + Copy, T: ?Sized,

pub const fn new( thing: &'a T, fg: Fg, bg: Bg, ) -> ComboDynColorDisplay<'a, Fg, Bg, T>

Create a new ComboDynColorDisplay, from a pair of types which implement DynColor.

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

Example

Usage in const contexts:

use owo_colors::{ComboDynColorDisplay, XtermColors};

const COMBO_DYN_TEXT: ComboDynColorDisplay<XtermColors, XtermColors, str> =
    ComboDynColorDisplay::new(
        "blue text on lilac background (dynamic)",
        XtermColors::BlueRibbon,
        XtermColors::WistfulLilac,
    );

println!("{}", COMBO_DYN_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

Typical use:

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

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

let styled_str = if is_black_on_white() {
    "hello".color(AnsiColors::Black).on_color(AnsiColors::White).into_styled()
} else {
    "hello".color(CssColors::White).on_color(CssColors::Black).into_styled()
};

println!("{}", styled_str);

pub const fn on_color<NewBg>( self, bg: NewBg, ) -> ComboDynColorDisplay<'a, Fg, NewBg, T>

where NewBg: DynColor,

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<NewFg>( self, fg: NewFg, ) -> ComboDynColorDisplay<'a, NewFg, Bg, T>

where NewFg: DynColor,

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, Fg, Bg, T> Binary for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: Binary + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> Debug for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> Display for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: Display + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> LowerExp for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: LowerExp + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> LowerHex for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: LowerHex + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> Octal for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: Octal + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> Pointer for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: Pointer + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> UpperExp for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: UpperExp + ?Sized,

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

Formats the value using the given formatter.

impl<'a, Fg, Bg, T> UpperHex for ComboDynColorDisplay<'a, Fg, Bg, T>

where Fg: DynColor, Bg: DynColor, T: UpperHex + ?Sized,

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

Formats the value using the given formatter.