Struct terminal_colorsaurus::ColorScheme

#[non_exhaustive]
pub struct ColorScheme {
    pub foreground: Color,
    pub background: Color,
}

The color scheme i.e. foreground and background colors of the terminal. Retrieved by calling color_scheme.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

foreground: Color

The foreground color of the terminal.

background: Color

The background color of the terminal.

Implementations

impl ColorScheme

pub fn is_dark_on_light(&self) -> bool

Tests if this color scheme uses dark text on a light background. This is done by computing and comparing the perceived brightness of the two colors.

pub fn is_light_on_dark(&self) -> bool

Tests if this color scheme uses light text on a dark background. This is done by computing and comparing the perceived brightness of the two colors.

Note that is_light_on_dark = !is_dark_on_light.

Examples found in repository

examples/theme.rs (line 10)

fn main() -> Result<(), Box<dyn Error>> {
    let colors = color_scheme(QueryOptions::default())?;

    let theme = if colors.is_light_on_dark() {
        "light on dark"
    } else {
        "dark on light"
    };

    println!(
        "{theme}, fg: {}, bg: {}",
        colors.foreground.perceived_lightness(),
        colors.background.perceived_lightness()
    );

    Ok(())
}

Trait Implementations

impl Clone for ColorScheme

fn clone(&self) -> ColorScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorScheme

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

Formats the value using the given formatter.

impl PartialEq for ColorScheme

fn eq(&self, other: &ColorScheme) -> 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 Eq for ColorScheme

impl StructuralPartialEq for ColorScheme