terminal_style 0.5.0

A minimal library for styling terminal text using ANSI escape codes.
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

use super::stylable::Stylable;
use crate::color::{rgb_from_color_definition, rgb_to_ansi8, ColorConversionError, IntoRgb};

/// Applies a foreground color using **24-bit TrueColor** ANSI sequences.
///
/// This function generates the sequence `\x1b[38;2;R;G;Bm`.
///
/// # Arguments
///
/// * `color_input` - Any type implementing [`IntoRgb`] (e.g., `#RRGGBB`, `[r, g, b]`, or `u8` ANSI).
/// * `text` - Any type implementing [`Stylable`] (e.g., `&str`, `String`, `Vec<String>`, `Vec<Vec<String>>`).
///
/// # Errors
///
/// Returns [`ColorConversionError`] if the color input is invalid.
///
/// # Example
///
/// ```
/// use terminal_style::format::color_rgb;
///
/// let s = color_rgb("#FF0000", "Red Text").unwrap();
/// assert_eq!(s, "\x1b[38;2;255;0;0mRed Text\x1b[0m");
/// ```
pub fn color_rgb<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    let f = |s: &str| -> Result<String, ColorConversionError> {
        let [r, g, b] = rgb_from_color_definition(color_input)?;
        Ok(format!("\x1b[38;2;{};{};{}m{}\x1b[0m", r, g, b, s))
    };
    text.apply_result(f)
}

/// Applies a background color using **24-bit TrueColor** ANSI sequences.
///
/// This function generates the sequence `\x1b[48;2;R;G;Bm`.
///
/// # Arguments
///
/// * `color_input` - Any type implementing [`IntoRgb`].
/// * `text` - Any type implementing [`Stylable`].
///
/// # Errors
///
/// Returns [`ColorConversionError`] if the color input is invalid.
///
/// # Example
///
/// ```
/// use terminal_style::format::background_rgb;
///
/// let s = background_rgb([0, 0, 255], "Blue BG").unwrap();
/// assert_eq!(s, "\x1b[48;2;0;0;255mBlue BG\x1b[0m");
/// ```
pub fn background_rgb<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    let f = |s: &str| -> Result<String, ColorConversionError> {
        let [r, g, b] = rgb_from_color_definition(color_input)?;
        Ok(format!("\x1b[48;2;{};{};{}m{}\x1b[0m", r, g, b, s))
    };
    text.apply_result(f)
}

/// Applies a foreground color using **8-bit ANSI** (256-color) sequences.
///
/// This function quantizes the input color to the nearest 8-bit ANSI index
/// and generates the sequence `\x1b[38;5;Nm`.
///
/// # Arguments
///
/// * `color_input` - Any type implementing [`IntoRgb`].
/// * `text` - Any type implementing [`Stylable`].
///
/// # Errors
///
/// Returns [`ColorConversionError`] if the color input is invalid.
///
/// # Example
///
/// ```
/// use terminal_style::format::color_ansi;
///
/// let s = color_ansi([255, 0, 0], "Red Text").unwrap();
/// assert_eq!(s, "\x1b[38;5;196mRed Text\x1b[0m");
/// ```
pub fn color_ansi<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    let f = |s: &str| -> Result<String, ColorConversionError> {
        let rgb = rgb_from_color_definition(color_input)?;
        let code = rgb_to_ansi8(rgb);
        Ok(format!("\x1b[38;5;{}m{}\x1b[0m", code, s))
    };
    text.apply_result(f)
}

/// Applies a background color using **8-bit ANSI** (256-color) sequences.
///
/// This function quantizes the input color to the nearest 8-bit ANSI index
/// and generates the sequence `\x1b[48;5;Nm`.
///
/// # Arguments
///
/// * `color_input` - Any type implementing [`IntoRgb`].
/// * `text` - Any type implementing [`Stylable`].
///
/// # Errors
///
/// Returns [`ColorConversionError`] if the color input is invalid.
///
/// # Example
///
/// ```
/// use terminal_style::format::background_ansi;
///
/// let s = background_ansi("#0000FF", "Blue BG").unwrap();
/// assert_eq!(s, "\x1b[48;5;21mBlue BG\x1b[0m");
/// ```
pub fn background_ansi<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    let f = |s: &str| -> Result<String, ColorConversionError> {
        let rgb = rgb_from_color_definition(color_input)?;
        let code = rgb_to_ansi8(rgb);
        Ok(format!("\x1b[48;5;{}m{}\x1b[0m", code, s))
    };
    text.apply_result(f)
}

/// Applies a foreground color using the default format (**TrueColor**).
///
/// Alias for [`color_rgb`].
pub fn color<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    color_rgb(color_input, text)
}

/// Applies a background color using the default format (**TrueColor**).
///
/// Alias for [`background_rgb`].
pub fn background<C, T>(color_input: C, text: T) -> Result<T::Output, ColorConversionError>
where
    C: Copy + IntoRgb,
    T: Stylable,
{
    background_rgb(color_input, text)
}