Struct owo_colors::Style[−][src]

pub struct Style { /* fields omitted */ }

A pre-computed style that can be applied to a struct using OwoColorize::style

Implementations

`impl Style`[src]

`pub fn new() -> Self`[src]

Create a new style to be applied later

`pub fn style<T>(&self, target: T) -> Styled<T>`[src]

Apply the style to a given struct to output

`pub fn fg<C: Color>(self) -> Self`[src]

Set the foreground color generically

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

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

`pub fn bg<C: Color>(self) -> Self`[src]

Set the background color generically.

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

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

`pub fn black(self) -> Self`[src]

Change the foreground color to black

`pub fn on_black(self) -> Self`[src]

Change the foreground color to black

`pub fn red(self) -> Self`[src]

Change the foreground color to red

`pub fn on_red(self) -> Self`[src]

Change the foreground color to red

`pub fn green(self) -> Self`[src]

Change the foreground color to green

`pub fn on_green(self) -> Self`[src]

Change the foreground color to green

`pub fn yellow(self) -> Self`[src]

Change the foreground color to yellow

`pub fn on_yellow(self) -> Self`[src]

Change the foreground color to yellow

`pub fn blue(self) -> Self`[src]

Change the foreground color to blue

`pub fn on_blue(self) -> Self`[src]

Change the foreground color to blue

`pub fn magenta(self) -> Self`[src]

Change the foreground color to magenta

`pub fn on_magenta(self) -> Self`[src]

Change the foreground color to magenta

`pub fn purple(self) -> Self`[src]

Change the foreground color to purple

`pub fn on_purple(self) -> Self`[src]

Change the foreground color to purple

`pub fn cyan(self) -> Self`[src]

Change the foreground color to cyan

`pub fn on_cyan(self) -> Self`[src]

Change the foreground color to cyan

`pub fn white(self) -> Self`[src]

Change the foreground color to white

`pub fn on_white(self) -> Self`[src]

Change the foreground color to white

`pub fn bright_black(self) -> Self`[src]

Change the foreground color to bright black

`pub fn on_bright_black(self) -> Self`[src]

Change the foreground color to bright black

`pub fn bright_red(self) -> Self`[src]

Change the foreground color to bright red

`pub fn on_bright_red(self) -> Self`[src]

Change the foreground color to bright red

`pub fn bright_green(self) -> Self`[src]

Change the foreground color to bright green

`pub fn on_bright_green(self) -> Self`[src]

Change the foreground color to bright green

`pub fn bright_yellow(self) -> Self`[src]

Change the foreground color to bright yellow

`pub fn on_bright_yellow(self) -> Self`[src]

Change the foreground color to bright yellow

`pub fn bright_blue(self) -> Self`[src]

Change the foreground color to bright blue

`pub fn on_bright_blue(self) -> Self`[src]

Change the foreground color to bright blue

`pub fn bright_magenta(self) -> Self`[src]

Change the foreground color to bright magenta

`pub fn on_bright_magenta(self) -> Self`[src]

Change the foreground color to bright magenta

`pub fn bright_purple(self) -> Self`[src]

Change the foreground color to bright purple

`pub fn on_bright_purple(self) -> Self`[src]

Change the foreground color to bright purple

`pub fn bright_cyan(self) -> Self`[src]

Change the foreground color to bright cyan

`pub fn on_bright_cyan(self) -> Self`[src]

Change the foreground color to bright cyan

`pub fn bright_white(self) -> Self`[src]

Change the foreground color to bright white

`pub fn on_bright_white(self) -> Self`[src]

Change the foreground color to bright white

`pub fn bold(self) -> Self`[src]

Make the text bold

`pub fn dimmed(self) -> Self`[src]

Make the text dim

`pub fn italic(self) -> Self`[src]

Make the text italicized

`pub fn underline(self) -> Self`[src]

Make the text italicized

`pub fn blink(self) -> Self`[src]

Make the text blink

`pub fn blink_fast(self) -> Self`[src]

Make the text blink (but fast!)

`pub fn reversed(self) -> Self`[src]

Swap the foreground and background colors

`pub fn hidden(self) -> Self`[src]

Hide the text

`pub fn strikethrough(self) -> Self`[src]

Cross out the text

`pub fn effect(self, effect: Effect) -> Self`[src]

Apply a given effect from the style

`pub fn remove_effect(self, effect: Effect) -> Self`[src]

Remove a given effect from the style

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

Apply a given set of effects to the style

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

Remove a given set of effects from the style

`pub fn remove_all_effects(self) -> Self`[src]

Disables all the given effects from the style

`pub fn color<Color: DynColor>(self, color: Color) -> Self`[src]

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>(self, color: Color) -> Self`[src]

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>(self) -> Self`[src]

Set the foreground color to a specific RGB value.

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

Set the background color to a specific RGB value.

`pub fn truecolor(self, r: u8, g: u8, b: u8) -> Self`[src]

Sets the foreground color to an RGB value.

`pub fn on_truecolor(self, r: u8, g: u8, b: u8) -> Self`[src]

Sets the background color to an RGB value.

Trait Implementations

`impl Clone for Style`[src]

`fn clone(&self) -> Style`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Style`[src]

`impl Debug for Style`[src]

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

`impl Default for Style`[src]

`fn default() -> Style`[src]

Auto Trait Implementations

`impl Send for Style`

`impl Sync for Style`

`impl Unpin for Style`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<D> OwoColorize for D`[src]

`fn fg<'a, C: Color>(&'a self) -> FgColorDisplay<'a, C, Self>`[src]

`fn bg<'a, C: Color>(&'a self) -> BgColorDisplay<'a, C, Self>`[src]

`fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>`[src]

`fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>`[src]

`fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>`[src]

`fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>`[src]

`fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>`[src]

`fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>`[src]

`fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>`[src]

`fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>`[src]

`fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>`[src]

`fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>`[src]

`fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>`[src]

`fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>`[src]

`fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>`[src]

`fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>`[src]

`fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>`[src]

`fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>`[src]

`fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>`[src]

`fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>`[src]

`fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>`[src]

`fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>`[src]

`fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>`[src]

`fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>`[src]

`fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>`[src]

`fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>`[src]

`fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>`[src]

`fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>`[src]

`fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>`[src]

`fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>`[src]

`fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>`[src]

`fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>`[src]

`fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>`[src]

`fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>`[src]

`fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>`[src]

`fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>`[src]

`fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>`[src]

`fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>`[src]

`fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>`[src]

`fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>`[src]

`fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>`[src]

`fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>`[src]

`fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>`[src]

`fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>`[src]

`fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>`[src]

`fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>`[src]

`fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>`[src]

`fn color<'a, Color: DynColor>( &'a self, color: Color ) -> FgDynColorDisplay<'a, Color, Self>`[src]

`fn on_color<'a, Color: DynColor>( &'a self, color: Color ) -> BgDynColorDisplay<'a, Color, Self>`[src]

`fn fg_rgb<'a, const R: u8, const G: u8, const B: u8>( &'a self ) -> FgColorDisplay<'a, CustomColor<R, G, B>, Self>`[src]

`fn bg_rgb<'a, const R: u8, const G: u8, const B: u8>( &'a self ) -> BgColorDisplay<'a, CustomColor<R, G, B>, Self>`[src]

`fn truecolor<'a>( &'a self, r: u8, g: u8, b: u8 ) -> FgDynColorDisplay<'a, Rgb, Self>`[src]

`fn on_truecolor<'a>( &'a self, r: u8, g: u8, b: u8 ) -> BgDynColorDisplay<'a, Rgb, Self>`[src]

`fn style(&self, style: Style) -> Styled<&Self>`[src]

`fn if_stdout_tty<'a, Out, ApplyFn>( &'a self, apply: ApplyFn ) -> TtyDisplay<'a, StdOut, Self, Out, ApplyFn> where ApplyFn: Fn(&'a Self) -> Out,` [src]

`fn if_stderr_tty<'a, Out, ApplyFn>( &'a self, apply: ApplyFn ) -> TtyDisplay<'a, StdErr, Self, Out, ApplyFn> where ApplyFn: Fn(&'a Self) -> Out,` [src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct owo_colors::Style[−][src]

Implementations

impl Style[src]

pub fn new() -> Self[src]

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

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

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

pub fn black(self) -> Self[src]

pub fn on_black(self) -> Self[src]

pub fn red(self) -> Self[src]

pub fn on_red(self) -> Self[src]

pub fn green(self) -> Self[src]

pub fn on_green(self) -> Self[src]

pub fn yellow(self) -> Self[src]

pub fn on_yellow(self) -> Self[src]

pub fn blue(self) -> Self[src]

pub fn on_blue(self) -> Self[src]

pub fn magenta(self) -> Self[src]

pub fn on_magenta(self) -> Self[src]

pub fn purple(self) -> Self[src]

pub fn on_purple(self) -> Self[src]

pub fn cyan(self) -> Self[src]

pub fn on_cyan(self) -> Self[src]

pub fn white(self) -> Self[src]

pub fn on_white(self) -> Self[src]

pub fn bright_black(self) -> Self[src]

pub fn on_bright_black(self) -> Self[src]

pub fn bright_red(self) -> Self[src]

pub fn on_bright_red(self) -> Self[src]

pub fn bright_green(self) -> Self[src]

pub fn on_bright_green(self) -> Self[src]

pub fn bright_yellow(self) -> Self[src]

pub fn on_bright_yellow(self) -> Self[src]

pub fn bright_blue(self) -> Self[src]

pub fn on_bright_blue(self) -> Self[src]

pub fn bright_magenta(self) -> Self[src]

pub fn on_bright_magenta(self) -> Self[src]

pub fn bright_purple(self) -> Self[src]

pub fn on_bright_purple(self) -> Self[src]

pub fn bright_cyan(self) -> Self[src]

pub fn on_bright_cyan(self) -> Self[src]

pub fn bright_white(self) -> Self[src]

pub fn on_bright_white(self) -> Self[src]

pub fn bold(self) -> Self[src]

pub fn dimmed(self) -> Self[src]

pub fn italic(self) -> Self[src]

pub fn underline(self) -> Self[src]

pub fn blink(self) -> Self[src]

pub fn blink_fast(self) -> Self[src]

pub fn reversed(self) -> Self[src]

pub fn hidden(self) -> Self[src]

pub fn strikethrough(self) -> Self[src]

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

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

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

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

pub fn remove_all_effects(self) -> Self[src]

pub fn color<Color: DynColor>(self, color: Color) -> Self[src]

pub fn on_color<Color: DynColor>(self, color: Color) -> Self[src]

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

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

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

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