Skip to main content

Colors

Struct Colors 

Source
pub struct Colors;
Expand description

Theme-aware color wrapper.

Use these instead of direct .green(), .red(), etc. to respect the active theme. Each method takes a string and a Theme, returning a styled string that adapts to the theme’s color palette.

§Example

use netspeed_cli::theme::{Colors, Theme};

// Monochrome always returns plain text (no ANSI escapes)
assert_eq!(Colors::good("OK", Theme::Monochrome), "OK");
assert_eq!(Colors::warn("caution", Theme::Monochrome), "caution");
assert_eq!(Colors::bad("FAIL", Theme::Monochrome), "FAIL");
assert_eq!(Colors::info("note", Theme::Monochrome), "note");

// Other themes add ANSI styling but always preserve the original text
assert!(Colors::good("OK", Theme::Dark).contains("OK"));
assert!(Colors::bad("FAIL", Theme::Light).contains("FAIL"));

Implementations§

Source§

impl Colors

Source

pub fn good(s: &str, theme: Theme) -> String

Good/success color.

Green in Dark/HighContrast/Light themes, plain text in Monochrome.

§Example
use netspeed_cli::theme::{Colors, Theme};

// Monochrome: plain text
assert_eq!(Colors::good("100 Mbps", Theme::Monochrome), "100 Mbps");

// Dark/Light/HighContrast: styled with green (contains the text)
assert!(Colors::good("100 Mbps", Theme::Dark).contains("100 Mbps"));
assert!(Colors::good("100 Mbps", Theme::Light).contains("100 Mbps"));
Source

pub fn warn(s: &str, theme: Theme) -> String

Warning/caution color.

Yellow in Dark/HighContrast/Light themes, plain text in Monochrome.

§Example
use netspeed_cli::theme::{Colors, Theme};

assert_eq!(Colors::warn("high latency", Theme::Monochrome), "high latency");
assert!(Colors::warn("high latency", Theme::Dark).contains("high latency"));
Source

pub fn bad(s: &str, theme: Theme) -> String

Error/bad color.

Red in Dark/HighContrast/Light themes, plain text in Monochrome.

§Example
use netspeed_cli::theme::{Colors, Theme};

assert_eq!(Colors::bad("FAILED", Theme::Monochrome), "FAILED");
assert!(Colors::bad("FAILED", Theme::Dark).contains("FAILED"));
Source

pub fn info(s: &str, theme: Theme) -> String

Info/neutral color (cyan/blue).

Cyan in Dark/HighContrast, blue in Light, plain text in Monochrome.

§Example
use netspeed_cli::theme::{Colors, Theme};

assert_eq!(Colors::info("Server: 1234", Theme::Monochrome), "Server: 1234");
assert!(Colors::info("Server: 1234", Theme::Dark).contains("Server: 1234"));
assert!(Colors::info("Server: 1234", Theme::Light).contains("Server: 1234"));
Source

pub fn dimmed(s: &str, theme: Theme) -> String

Dimmed/secondary text.

Dimmed in Dark/Light, plain text in HighContrast/Monochrome (kept readable at high contrast).

§Example
use netspeed_cli::theme::{Colors, Theme};

// Monochrome and HighContrast: plain text (readability over style)
assert_eq!(Colors::dimmed("secondary", Theme::Monochrome), "secondary");
assert_eq!(Colors::dimmed("secondary", Theme::HighContrast), "secondary");

// Dark/Light: dimmed styling (contains the text)
assert!(Colors::dimmed("secondary", Theme::Dark).contains("secondary"));
assert!(Colors::dimmed("secondary", Theme::Light).contains("secondary"));
Source

pub fn bold(s: &str, _theme: Theme) -> String

Bold/emphasized text.

Always applies bold regardless of theme (theme parameter reserved for future theme-specific bold behavior).

§Example
use netspeed_cli::theme::{Colors, Theme};

// Bold always contains the original text
assert!(Colors::bold("important", Theme::Dark).contains("important"));
assert!(Colors::bold("important", Theme::Light).contains("important"));
assert!(Colors::bold("important", Theme::Monochrome).contains("important"));
Source

pub fn muted(s: &str, theme: Theme) -> String

Muted/secondary text (bright_black equivalent).

Bright black in Dark/HighContrast, dimmed in Light, plain in Monochrome.

§Example
use netspeed_cli::theme::{Colors, Theme};

// Monochrome: plain text
assert_eq!(Colors::muted("hint", Theme::Monochrome), "hint");

// Other themes contain the original text
assert!(Colors::muted("hint", Theme::Dark).contains("hint"));
assert!(Colors::muted("hint", Theme::Light).contains("hint"));
assert!(Colors::muted("hint", Theme::HighContrast).contains("hint"));
Source

pub fn header(s: &str, theme: Theme) -> String

Header/section title color.

Cyan+bold+underline in Dark/HighContrast, blue+bold+underline in Light, plain text in Monochrome (no color/underline).

§Example
use netspeed_cli::theme::{Colors, Theme};

// Monochrome: plain text (no color/underline)
assert!(Colors::header("Results", Theme::Monochrome).contains("Results"));

// Dark: cyan + bold + underline
assert!(Colors::header("Results", Theme::Dark).contains("Results"));

// Light: blue + bold + underline
assert!(Colors::header("Results", Theme::Light).contains("Results"));

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

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>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
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, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
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, 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§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more