Struct owo_colors::Style

source · [−]

pub struct Style { /* private fields */ }

Expand description

A pre-computed style that can be applied to a struct using OwoColorize::style. Its interface mimicks that of OwoColorize, but instead of chaining methods on your object, you instead chain them on the Style object before applying it.

use owo_colors::{OwoColorize, Style};

let my_style = Style::new()
    .red()
    .on_white()
    .strikethrough();

println!("{}", "red text, white background, struck through".style(my_style));

Implementations

source

impl Style

source

pub fn new() -> Self

Create a new style to be applied later

source

pub fn style<T>(&self, target: T) -> Styled<T>

Apply the style to a given struct to output

source

pub fn fg<C: Color>(self) -> Self

Set the foreground color generically

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

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

source

pub fn bg<C: Color>(self) -> Self

Set the background color generically.

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

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

source

pub fn remove_fg(self) -> Self

Removes the foreground color from the style. Note that this does not apply the default color, but rather represents not changing the current terminal color.

If you wish to actively change the terminal color back to the default, see Style::default_color.

source

pub fn remove_bg(self) -> Self

Removes the background color from the style. Note that this does not apply the default color, but rather represents not changing the current terminal color.

If you wish to actively change the terminal color back to the default, see Style::on_default_color.

source

pub fn black(self) -> Self

Change the foreground color to black

source

pub fn on_black(self) -> Self

Change the foreground color to black

source

pub fn red(self) -> Self

Change the foreground color to red

source

pub fn on_red(self) -> Self

Change the foreground color to red

source

pub fn green(self) -> Self

Change the foreground color to green

source

pub fn on_green(self) -> Self

Change the foreground color to green

source

pub fn yellow(self) -> Self

Change the foreground color to yellow

source

pub fn on_yellow(self) -> Self

Change the foreground color to yellow

source

pub fn blue(self) -> Self

Change the foreground color to blue

source

pub fn on_blue(self) -> Self

Change the foreground color to blue

source

pub fn magenta(self) -> Self

Change the foreground color to magenta

source

pub fn on_magenta(self) -> Self

Change the foreground color to magenta

source

pub fn purple(self) -> Self

Change the foreground color to purple

source

pub fn on_purple(self) -> Self

Change the foreground color to purple

source

pub fn cyan(self) -> Self

Change the foreground color to cyan

source

pub fn on_cyan(self) -> Self

Change the foreground color to cyan

source

pub fn white(self) -> Self

Change the foreground color to white

source

pub fn on_white(self) -> Self

Change the foreground color to white

source

pub fn default_color(self) -> Self

Change the foreground color to the terminal default

source

pub fn on_default_color(self) -> Self

Change the foreground color to the terminal default

source

pub fn bright_black(self) -> Self

Change the foreground color to bright black

source

pub fn on_bright_black(self) -> Self

Change the foreground color to bright black

source

pub fn bright_red(self) -> Self

Change the foreground color to bright red

source

pub fn on_bright_red(self) -> Self

Change the foreground color to bright red

source

pub fn bright_green(self) -> Self

Change the foreground color to bright green

source

pub fn on_bright_green(self) -> Self

Change the foreground color to bright green

source

pub fn bright_yellow(self) -> Self

Change the foreground color to bright yellow

source

pub fn on_bright_yellow(self) -> Self

Change the foreground color to bright yellow

source

pub fn bright_blue(self) -> Self

Change the foreground color to bright blue

source

pub fn on_bright_blue(self) -> Self

Change the foreground color to bright blue

source

pub fn bright_magenta(self) -> Self

Change the foreground color to bright magenta

source

pub fn on_bright_magenta(self) -> Self

Change the foreground color to bright magenta

source

pub fn bright_purple(self) -> Self

Change the foreground color to bright purple

source

pub fn on_bright_purple(self) -> Self

Change the foreground color to bright purple

source

pub fn bright_cyan(self) -> Self

Change the foreground color to bright cyan

source

pub fn on_bright_cyan(self) -> Self

Change the foreground color to bright cyan

source

pub fn bright_white(self) -> Self

Change the foreground color to bright white

source

pub fn on_bright_white(self) -> Self

Change the foreground color to bright white

source

pub fn bold(self) -> Self

Make the text bold

source

pub fn dimmed(self) -> Self

Make the text dim

source

pub fn italic(self) -> Self

Make the text italicized

source

pub fn underline(self) -> Self

Make the text italicized

source

pub fn blink(self) -> Self

Make the text blink

source

pub fn blink_fast(self) -> Self

Make the text blink (but fast!)

source

pub fn reversed(self) -> Self

Swap the foreground and background colors

source

pub fn hidden(self) -> Self

Hide the text

source

pub fn strikethrough(self) -> Self

Cross out the text

source

pub fn effect(self, effect: Effect) -> Self

Apply a given effect from the style

source

pub fn remove_effect(self, effect: Effect) -> Self

Remove a given effect from the style

source

pub fn effects(self, effects: &[Effect]) -> Self

Apply a given set of effects to the style

source

pub fn remove_effects(self, effects: &[Effect]) -> Self

Remove a given set of effects from the style

source

pub fn remove_all_effects(self) -> Self

Disables all the given effects from the style

source

pub fn color<Color: DynColor>(self, color: 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,

use owo_colors::{OwoColorize, AnsiColors};

println!("{}", "green".color(AnsiColors::Green));

source

pub fn on_color<Color: DynColor>(self, color: 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,

use owo_colors::{OwoColorize, AnsiColors};

println!("{}", "yellow background".on_color(AnsiColors::BrightYellow));

source

pub fn fg_rgb<const R: u8, const G: u8, const B: u8>(self) -> Self

Set the foreground color to a specific RGB value.

source

pub fn bg_rgb<const R: u8, const G: u8, const B: u8>(self) -> Self

Set the background color to a specific RGB value.

source

pub fn truecolor(self, r: u8, g: u8, b: u8) -> Self

Sets the foreground color to an RGB value.

source

pub fn on_truecolor(self, r: u8, g: u8, b: u8) -> Self

Sets the background color to an RGB value.

source

pub fn is_plain(&self) -> bool

Returns if the style does not apply any formatting

source

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

Applies the ANSI-prefix for this style to the given formatter

source

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

Applies the ANSI-suffix for this style to the given formatter

Trait Implementations

source

impl Clone for Style

source

fn clone(&self) -> Style

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for Style

source

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

Formats the value using the given formatter. Read more

source

impl Default for Style

source

fn default() -> Style

Returns the “default value” for a type. Read more

source

impl PartialEq<Style> for Style

source

fn eq(&self, other: &Style) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Copy for Style

source

impl StructuralPartialEq for Style

Auto Trait Implementations

impl RefUnwindSafe for Style

impl Send for Style

impl Sync for Style

impl Unpin for Style

impl UnwindSafe for Style

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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

source

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

source

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

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