helpers4 0.0.6

General-purpose Rust helpers, one crate, one feature per module (string, array, ...)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

// This file is part of helpers4.
// Copyright (C) 2025 baxyz
// SPDX-License-Identifier: LGPL-3.0-or-later

/// A terminal color for [`Style`](super::Style).
///
/// The 8 standard colors and their bright variants work everywhere; [`Color::Ansi256`] and
/// [`Color::Rgb`] need a terminal that supports 256 or true colors.
///
/// # Examples
///
/// ```
/// use helpers4::ansi::{Color, Style};
///
/// assert_eq!(Style::new().fg(Color::Green).paint("ok"), "\u{1b}[32mok\u{1b}[0m");
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Color {
    /// Black.
    Black,
    /// Red.
    Red,
    /// Green.
    Green,
    /// Yellow.
    Yellow,
    /// Blue.
    Blue,
    /// Magenta.
    Magenta,
    /// Cyan.
    Cyan,
    /// White (light grey on most terminals).
    White,
    /// Bright black (dark grey).
    BrightBlack,
    /// Bright red.
    BrightRed,
    /// Bright green.
    BrightGreen,
    /// Bright yellow.
    BrightYellow,
    /// Bright blue.
    BrightBlue,
    /// Bright magenta.
    BrightMagenta,
    /// Bright cyan.
    BrightCyan,
    /// Bright white.
    BrightWhite,
    /// A color of the 256-color palette, `0..=255`.
    Ansi256(u8),
    /// A true color.
    Rgb(u8, u8, u8),
}

impl Color {
    /// The SGR parameters that select this color: as the foreground when `background` is false,
    /// as the background otherwise (`31` or `41` for red, `38;5;n`, `38;2;r;g;b`, ...).
    pub(crate) fn sgr(self, background: bool) -> String {
        let (base, bright_base, extended) = if background {
            (40, 100, 48)
        } else {
            (30, 90, 38)
        };
        let index = |offset: u8| (base + offset).to_string();
        let bright = |offset: u8| (bright_base + offset).to_string();
        match self {
            Self::Black => index(0),
            Self::Red => index(1),
            Self::Green => index(2),
            Self::Yellow => index(3),
            Self::Blue => index(4),
            Self::Magenta => index(5),
            Self::Cyan => index(6),
            Self::White => index(7),
            Self::BrightBlack => bright(0),
            Self::BrightRed => bright(1),
            Self::BrightGreen => bright(2),
            Self::BrightYellow => bright(3),
            Self::BrightBlue => bright(4),
            Self::BrightMagenta => bright(5),
            Self::BrightCyan => bright(6),
            Self::BrightWhite => bright(7),
            Self::Ansi256(n) => format!("{extended};5;{n}"),
            Self::Rgb(r, g, b) => format!("{extended};2;{r};{g};{b}"),
        }
    }
}

#[cfg(test)]
#[path = "color.test.rs"]
mod tests;