Struct FgColorDisplay

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

Transparent wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the foreground color. Recommended to be constructed using OwoColorize.

Implementations

impl<'a, Fg, T: ?Sized> FgColorDisplay<'a, Fg, T>

where Fg: Color,

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

Create a new FgColorDisplay, from a reference to a type which implements Color.

This is a const function: in non-const contexts, OwoColorize::fg or one of the other methods on it may be more convenient.

Example

Usage in const contexts:

use owo_colors::{colors::Green, FgColorDisplay};

const GREEN_TEXT: FgColorDisplay<Green, str> = FgColorDisplay::new("green");

println!("{}", GREEN_TEXT);

pub const 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::OwoColorize;

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

let styled_str = if is_blue() {
    "hello".blue().into_styled()
} else {
    "hello".green().into_styled()
};

println!("{}", styled_str);

Usage in const contexts:

use owo_colors::{colors::{Blue, Green}, FgColorDisplay, Styled};

const fn is_blue() -> bool {
    // ...
}

const STYLED_STR: Styled<&str> = if is_blue() {
    FgColorDisplay::<Blue, _>::new("Hello").into_styled()
} else {
    FgColorDisplay::<Green, _>::new("Hello").into_styled()
};

println!("{}", STYLED_STR);

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

pub const fn on_color<NewBg: DynColor>( self, bg: NewBg, ) -> ComboDynColorDisplay<'a, Fg::DynEquivalent, 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 fg<C: Color>(self) -> FgColorDisplay<'a, C, T>

Set the foreground color generically

use owo_colors::{OwoColorize, colors::*};

println!("{}", "red foreground".fg::<Red>());

pub const fn bg<C: Color>(self) -> ComboColorDisplay<'a, Fg, C, T>

Set the background color generically.

use owo_colors::{OwoColorize, colors::*};

println!("{}", "black background".bg::<Black>());

pub const fn black(self) -> FgColorDisplay<'a, Black, T>

Change the foreground color to black

pub const fn on_black(self) -> ComboColorDisplay<'a, Fg, Black, T>

Change the background color to black

pub const fn red(self) -> FgColorDisplay<'a, Red, T>

Change the foreground color to red

pub const fn on_red(self) -> ComboColorDisplay<'a, Fg, Red, T>

Change the background color to red

pub const fn green(self) -> FgColorDisplay<'a, Green, T>

Change the foreground color to green

pub const fn on_green(self) -> ComboColorDisplay<'a, Fg, Green, T>

Change the background color to green

pub const fn yellow(self) -> FgColorDisplay<'a, Yellow, T>

Change the foreground color to yellow

pub const fn on_yellow(self) -> ComboColorDisplay<'a, Fg, Yellow, T>

Change the background color to yellow

pub const fn blue(self) -> FgColorDisplay<'a, Blue, T>

Change the foreground color to blue

pub const fn on_blue(self) -> ComboColorDisplay<'a, Fg, Blue, T>

Change the background color to blue

pub const fn magenta(self) -> FgColorDisplay<'a, Magenta, T>

Change the foreground color to magenta

pub const fn on_magenta(self) -> ComboColorDisplay<'a, Fg, Magenta, T>

Change the background color to magenta

pub const fn purple(self) -> FgColorDisplay<'a, Magenta, T>

Change the foreground color to purple

pub const fn on_purple(self) -> ComboColorDisplay<'a, Fg, Magenta, T>

Change the background color to purple

pub const fn cyan(self) -> FgColorDisplay<'a, Cyan, T>

Change the foreground color to cyan

pub const fn on_cyan(self) -> ComboColorDisplay<'a, Fg, Cyan, T>

Change the background color to cyan

pub const fn white(self) -> FgColorDisplay<'a, White, T>

Change the foreground color to white

pub const fn on_white(self) -> ComboColorDisplay<'a, Fg, White, T>

Change the background color to white

pub const fn bright_black(self) -> FgColorDisplay<'a, BrightBlack, T>

Change the foreground color to bright black

pub const fn on_bright_black(self) -> ComboColorDisplay<'a, Fg, BrightBlack, T>

Change the background color to bright black

pub const fn bright_red(self) -> FgColorDisplay<'a, BrightRed, T>

Change the foreground color to bright red

pub const fn on_bright_red(self) -> ComboColorDisplay<'a, Fg, BrightRed, T>

Change the background color to bright red

pub const fn bright_green(self) -> FgColorDisplay<'a, BrightGreen, T>

Change the foreground color to bright green

pub const fn on_bright_green(self) -> ComboColorDisplay<'a, Fg, BrightGreen, T>

Change the background color to bright green

pub const fn bright_yellow(self) -> FgColorDisplay<'a, BrightYellow, T>

Change the foreground color to bright yellow

pub const fn on_bright_yellow( self, ) -> ComboColorDisplay<'a, Fg, BrightYellow, T>

Change the background color to bright yellow

pub const fn bright_blue(self) -> FgColorDisplay<'a, BrightBlue, T>

Change the foreground color to bright blue

pub const fn on_bright_blue(self) -> ComboColorDisplay<'a, Fg, BrightBlue, T>

Change the background color to bright blue

pub const fn bright_magenta(self) -> FgColorDisplay<'a, BrightMagenta, T>

Change the foreground color to bright magenta

pub const fn on_bright_magenta( self, ) -> ComboColorDisplay<'a, Fg, BrightMagenta, T>

Change the background color to bright magenta

pub const fn bright_purple(self) -> FgColorDisplay<'a, BrightMagenta, T>

Change the foreground color to bright purple

pub const fn on_bright_purple( self, ) -> ComboColorDisplay<'a, Fg, BrightMagenta, T>

Change the background color to bright purple

pub const fn bright_cyan(self) -> FgColorDisplay<'a, BrightCyan, T>

Change the foreground color to bright cyan

pub const fn on_bright_cyan(self) -> ComboColorDisplay<'a, Fg, BrightCyan, T>

Change the background color to bright cyan

pub const fn bright_white(self) -> FgColorDisplay<'a, BrightWhite, T>

Change the foreground color to bright white

pub const fn on_bright_white(self) -> ComboColorDisplay<'a, Fg, BrightWhite, T>

Change the background color to bright white

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.