Struct inoculate::term::Style

pub struct Style { /* private fields */ }

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

impl Style

pub fn new() -> Style

Create a new style to be applied later

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

Apply the style to a given struct to output

pub fn fg<C>(self) -> Style

where C: Color,

Set the foreground color generically

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

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

pub fn bg<C>(self) -> Style

where C: Color,

Set the background color generically.

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

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

pub fn remove_fg(self) -> Style

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.

pub fn remove_bg(self) -> Style

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.

pub fn black(self) -> Style

Change the foreground color to black

pub fn on_black(self) -> Style

Change the foreground color to black

pub fn red(self) -> Style

Change the foreground color to red

pub fn on_red(self) -> Style

Change the foreground color to red

pub fn green(self) -> Style

Change the foreground color to green

pub fn on_green(self) -> Style

Change the foreground color to green

pub fn yellow(self) -> Style

Change the foreground color to yellow

pub fn on_yellow(self) -> Style

Change the foreground color to yellow

pub fn blue(self) -> Style

Change the foreground color to blue

pub fn on_blue(self) -> Style

Change the foreground color to blue

pub fn magenta(self) -> Style

Change the foreground color to magenta

pub fn on_magenta(self) -> Style

Change the foreground color to magenta

pub fn purple(self) -> Style

Change the foreground color to purple

pub fn on_purple(self) -> Style

Change the foreground color to purple

pub fn cyan(self) -> Style

Change the foreground color to cyan

pub fn on_cyan(self) -> Style

Change the foreground color to cyan

pub fn white(self) -> Style

Change the foreground color to white

pub fn on_white(self) -> Style

Change the foreground color to white

pub fn default_color(self) -> Style

Change the foreground color to the terminal default

pub fn on_default_color(self) -> Style

Change the foreground color to the terminal default

pub fn bright_black(self) -> Style

Change the foreground color to bright black

pub fn on_bright_black(self) -> Style

Change the foreground color to bright black

pub fn bright_red(self) -> Style

Change the foreground color to bright red

pub fn on_bright_red(self) -> Style

Change the foreground color to bright red

pub fn bright_green(self) -> Style

Change the foreground color to bright green

pub fn on_bright_green(self) -> Style

Change the foreground color to bright green

pub fn bright_yellow(self) -> Style

Change the foreground color to bright yellow

pub fn on_bright_yellow(self) -> Style

Change the foreground color to bright yellow

pub fn bright_blue(self) -> Style

Change the foreground color to bright blue

pub fn on_bright_blue(self) -> Style

Change the foreground color to bright blue

pub fn bright_magenta(self) -> Style

Change the foreground color to bright magenta

pub fn on_bright_magenta(self) -> Style

Change the foreground color to bright magenta

pub fn bright_purple(self) -> Style

Change the foreground color to bright purple

pub fn on_bright_purple(self) -> Style

Change the foreground color to bright purple

pub fn bright_cyan(self) -> Style

Change the foreground color to bright cyan

pub fn on_bright_cyan(self) -> Style

Change the foreground color to bright cyan

pub fn bright_white(self) -> Style

Change the foreground color to bright white

pub fn on_bright_white(self) -> Style

Change the foreground color to bright white

pub fn bold(self) -> Style

Make the text bold

pub fn dimmed(self) -> Style

Make the text dim

pub fn italic(self) -> Style

Make the text italicized

pub fn underline(self) -> Style

Make the text italicized

pub fn blink(self) -> Style

Make the text blink

pub fn blink_fast(self) -> Style

Make the text blink (but fast!)

pub fn reversed(self) -> Style

Swap the foreground and background colors

pub fn hidden(self) -> Style

Hide the text

pub fn strikethrough(self) -> Style

Cross out the text

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

Apply a given effect from the style

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

Remove a given effect from the style

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

Apply a given set of effects to the style

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

Remove a given set of effects from the style

pub fn remove_all_effects(self) -> Style

Disables all the given effects from the style

pub fn color<Color>(self, color: Color) -> Style

where Color: 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));

pub fn on_color<Color>(self, color: Color) -> Style

where Color: 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 fn fg_rgb<const R: u8, const G: u8, const B: u8>(self) -> Style

Set the foreground color to a specific RGB value.

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

Set the background color to a specific RGB value.

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

Sets the foreground color to an RGB value.

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

Sets the background color to an RGB value.

pub fn is_plain(&self) -> bool

Returns if the style does not apply any formatting

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

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

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

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

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl PartialEq for Style

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

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

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.

impl Copy for Style

impl StructuralPartialEq for Style