Struct owo_colors::Style

pub struct Style { /* fields omitted */ }

Implementations

impl Style

pub fn new() -> Self

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

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

Set the foreground color generically

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

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

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

Set the background color generically.

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

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

pub fn black(mut self: Self) -> Self

Change the foreground color to black

pub fn on_black(mut self: Self) -> Self

Change the foreground color to black

pub fn red(mut self: Self) -> Self

Change the foreground color to red

pub fn on_red(mut self: Self) -> Self

Change the foreground color to red

pub fn green(mut self: Self) -> Self

Change the foreground color to green

pub fn on_green(mut self: Self) -> Self

Change the foreground color to green

pub fn yellow(mut self: Self) -> Self

Change the foreground color to yellow

pub fn on_yellow(mut self: Self) -> Self

Change the foreground color to yellow

pub fn blue(mut self: Self) -> Self

Change the foreground color to blue

pub fn on_blue(mut self: Self) -> Self

Change the foreground color to blue

pub fn magenta(mut self: Self) -> Self

Change the foreground color to magenta

pub fn on_magenta(mut self: Self) -> Self

Change the foreground color to magenta

pub fn purple(mut self: Self) -> Self

Change the foreground color to purple

pub fn on_purple(mut self: Self) -> Self

Change the foreground color to purple

pub fn cyan(mut self: Self) -> Self

Change the foreground color to cyan

pub fn on_cyan(mut self: Self) -> Self

Change the foreground color to cyan

pub fn white(mut self: Self) -> Self

Change the foreground color to white

pub fn on_white(mut self: Self) -> Self

Change the foreground color to white

pub fn bright_black(mut self: Self) -> Self

Change the foreground color to bright black

pub fn on_bright_black(mut self: Self) -> Self

Change the foreground color to bright black

pub fn bright_red(mut self: Self) -> Self

Change the foreground color to bright red

pub fn on_bright_red(mut self: Self) -> Self

Change the foreground color to bright red

pub fn bright_green(mut self: Self) -> Self

Change the foreground color to bright green

pub fn on_bright_green(mut self: Self) -> Self

Change the foreground color to bright green

pub fn bright_yellow(mut self: Self) -> Self

Change the foreground color to bright yellow

pub fn on_bright_yellow(mut self: Self) -> Self

Change the foreground color to bright yellow

pub fn bright_blue(mut self: Self) -> Self

Change the foreground color to bright blue

pub fn on_bright_blue(mut self: Self) -> Self

Change the foreground color to bright blue

pub fn bright_magenta(mut self: Self) -> Self

Change the foreground color to bright magenta

pub fn on_bright_magenta(mut self: Self) -> Self

Change the foreground color to bright magenta

pub fn bright_purple(mut self: Self) -> Self

Change the foreground color to bright purple

pub fn on_bright_purple(mut self: Self) -> Self

Change the foreground color to bright purple

pub fn bright_cyan(mut self: Self) -> Self

Change the foreground color to bright cyan

pub fn on_bright_cyan(mut self: Self) -> Self

Change the foreground color to bright cyan

pub fn bright_white(mut self: Self) -> Self

Change the foreground color to bright white

pub fn on_bright_white(mut self: Self) -> Self

Change the foreground color to bright white

pub fn bold(mut self: Self) -> Self

Make the text bold

pub fn dimmed(mut self: Self) -> Self

Make the text dim

pub fn italic(mut self: Self) -> Self

Make the text italicized

pub fn underline(mut self: Self) -> Self

Make the text italicized

pub fn blink(mut self: Self) -> Self

Make the text blink

pub fn blink_fast(mut self: Self) -> Self

Make the text blink (but fast!)

pub fn reversed(mut self: Self) -> Self

Swap the foreground and background colors

pub fn hidden(mut self: Self) -> Self

Hide the text

pub fn strikethrough(mut self: Self) -> Self

Cross out the text

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

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

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

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

pub fn remove_all_effects(mut self: Self) -> Self

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

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

pub fn on_color<Color: DynColor>(mut self: 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};

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

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

Set the foreground color to a specific RGB value.

Requires: nightly and the custom feature.

If nightly is not preferable for you, use OwoColorize::truecolor

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

Set the background color to a specific RGB value.

Requires: nightly and the custom feature.

If nightly is not preferable for you, use OwoColorize::on_truecolor

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

Sets the foreground color to an RGB value.

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

Sets the background color to an RGB value.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Style

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the "default value" for a type.