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 mimics 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 const 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 const fn black(self) -> Self

Change the foreground color to black

source

pub const fn on_black(self) -> Self

Change the foreground color to black

source

pub const fn red(self) -> Self

Change the foreground color to red

source

pub const fn on_red(self) -> Self

Change the foreground color to red

source

pub const fn green(self) -> Self

Change the foreground color to green

source

pub const fn on_green(self) -> Self

Change the foreground color to green

source

pub const fn yellow(self) -> Self

Change the foreground color to yellow

source

pub const fn on_yellow(self) -> Self

Change the foreground color to yellow

source

pub const fn blue(self) -> Self

Change the foreground color to blue

source

pub const fn on_blue(self) -> Self

Change the foreground color to blue

source

pub const fn magenta(self) -> Self

Change the foreground color to magenta

source

pub const fn on_magenta(self) -> Self

Change the foreground color to magenta

source

pub const fn purple(self) -> Self

Change the foreground color to purple

source

pub const fn on_purple(self) -> Self

Change the foreground color to purple

source

pub const fn cyan(self) -> Self

Change the foreground color to cyan

source

pub const fn on_cyan(self) -> Self

Change the foreground color to cyan

source

pub const fn white(self) -> Self

Change the foreground color to white

source

pub const fn on_white(self) -> Self

Change the foreground color to white

source

pub const fn default_color(self) -> Self

Change the foreground color to the terminal default

source

pub const fn on_default_color(self) -> Self

Change the foreground color to the terminal default

source

pub const fn bright_black(self) -> Self

Change the foreground color to bright black

source

pub const fn on_bright_black(self) -> Self

Change the foreground color to bright black

source

pub const fn bright_red(self) -> Self

Change the foreground color to bright red

source

pub const fn on_bright_red(self) -> Self

Change the foreground color to bright red

source

pub const fn bright_green(self) -> Self

Change the foreground color to bright green

source

pub const fn on_bright_green(self) -> Self

Change the foreground color to bright green

source

pub const fn bright_yellow(self) -> Self

Change the foreground color to bright yellow

source

pub const fn on_bright_yellow(self) -> Self

Change the foreground color to bright yellow

source

pub const fn bright_blue(self) -> Self

Change the foreground color to bright blue

source

pub const fn on_bright_blue(self) -> Self

Change the foreground color to bright blue

source

pub const fn bright_magenta(self) -> Self

Change the foreground color to bright magenta

source

pub const fn on_bright_magenta(self) -> Self

Change the foreground color to bright magenta

source

pub const fn bright_purple(self) -> Self

Change the foreground color to bright purple

source

pub const fn on_bright_purple(self) -> Self

Change the foreground color to bright purple

source

pub const fn bright_cyan(self) -> Self

Change the foreground color to bright cyan

source

pub const fn on_bright_cyan(self) -> Self

Change the foreground color to bright cyan

source

pub const fn bright_white(self) -> Self

Change the foreground color to bright white

source

pub const 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 underlined

Make the text blink

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() -> Self

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

impl PartialEq for Style

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Style

source§

impl StructuralPartialEq for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

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,

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
source§

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

Change the background color to black
source§

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

Change the foreground color to red
source§

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

Change the background color to red
source§

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

Change the foreground color to green
source§

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

Change the background color to green
source§

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

Change the foreground color to yellow
source§

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

Change the background color to yellow
source§

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

Change the foreground color to blue
source§

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

Change the background color to blue
source§

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

Change the foreground color to magenta
source§

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

Change the background color to magenta
source§

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

Change the foreground color to purple
source§

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

Change the background color to purple
source§

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

Change the foreground color to cyan
source§

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

Change the background color to cyan
source§

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

Change the foreground color to white
source§

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

Change the background color to white
source§

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

Change the foreground color to the terminal default
source§

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

Change the background color to the terminal default
source§

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

Change the foreground color to bright black
source§

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

Change the background color to bright black
source§

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

Change the foreground color to bright red
source§

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

Change the background color to bright red
source§

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

Change the foreground color to bright green
source§

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

Change the background color to bright green
source§

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

Change the foreground color to bright yellow
source§

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

Change the background color to bright yellow
source§

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

Change the foreground color to bright blue
source§

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

Change the background color to bright blue
source§

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

Change the foreground color to bright magenta
source§

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

Change the background color to bright magenta
source§

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

Change the foreground color to bright purple
source§

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

Change the background color to bright purple
source§

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

Change the foreground color to bright cyan
source§

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

Change the background color to bright cyan
source§

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

Change the foreground color to bright white
source§

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

Change the background color to bright white
source§

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

Make the text bold
source§

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

Make the text dim
source§

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

Make the text italicized
source§

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

Make the text underlined
Make the text blink
Make the text blink (but fast!)
source§

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

Swap the foreground and background colors
source§

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

Hide the text
source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, 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: impl Into<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> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.