coloriz 0.2.0

A simple library for colorful temrinal
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
161
162
163
164
165
166

use crate::{ANSIColorCode, TargetGround, HSL};
use std::{f32, fmt, ops};

/// [RGB] color
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RGB {
    /// Red
    pub r: u8,
    /// Green
    pub g: u8,
    /// Blue
    pub b: u8,
}

impl RGB {
    /// Creates a new [RGB] color
    #[inline]
    pub const fn new(r: u8, g: u8, b: u8) -> Self {
        Self { r, g, b }
    }

    /// Creates a new [RGB] color with a hex code
    #[inline]
    pub const fn from_hex(hex: u32) -> Self {
        Self::new((hex >> 16) as u8, (hex >> 8) as u8, hex as u8)
    }

    /// Creates a new [RGB] color with three [f32] values
    pub fn from_f32(r: f32, g: f32, b: f32) -> Self {
        Self::new(
            (r.clamp(0.0, 1.0) * 255.0) as u8,
            (g.clamp(0.0, 1.0) * 255.0) as u8,
            (b.clamp(0.0, 1.0) * 255.0) as u8,
        )
    }

    /// Creates a grayscale [RGB] color
    #[inline]
    pub const fn gray(x: u8) -> Self {
        Self::new(x, x, x)
    }

    /// Creates a grayscale [RGB] color with a [f32] value
    pub fn gray_f32(x: f32) -> Self {
        Self::from_f32(x, x, x)
    }

    /// Creates a new [RGB] color from a [HSL] color
    pub fn from_hsl(hsl: HSL) -> Self {
        hsl.as_rgb()
    }

    /// Converts a [RGB] to a [HSL]
    pub fn as_hsl(&self) -> HSL {
        let r = self.r as f32 / 255.0;
        let g = self.g as f32 / 255.0;
        let b = self.b as f32 / 255.0;
        let c_max = r.max(g).max(b);
        let c_min = r.min(g).min(b);
        let delta = c_max - c_min;

        let h = if delta == 0.0 {
            0.0
        } else if c_max == r {
            f32::consts::FRAC_PI_3 * ((g - b) / delta).rem_euclid(6.0)
        } else if c_max == g {
            f32::consts::FRAC_PI_3 * ((b - r) / delta + 2.0)
        } else {
            f32::consts::FRAC_PI_3 * ((r - g) / delta + 4.0)
        };

        let l = 0.5 * (c_max + c_min);
        let s = if delta == 0.0 {
            0.0
        } else {
            delta / (1.0 - (2.0 * l - 1.0).abs())
        };

        HSL::new(h, s, l)
    } 

    /// Computes the linear interpolation between `self` and `other` for `t`
    pub fn lerp(&self, other: Self, t: f32) -> Self {
        let t = t.clamp(0.0, 1.0);
        self * (1.0 - t) + other * t
    }
}

impl From<(u8, u8, u8)> for RGB {
    fn from((r, g, b): (u8, u8, u8)) -> Self {
        Self::new(r, g, b)
    }
}

impl From<(f32, f32, f32)> for RGB {
    fn from((r, g, b): (f32, f32, f32)) -> Self {
        Self::from_f32(r, g, b)
    }
}

impl From<HSL> for RGB {
    fn from(hsl: HSL) -> Self {
        hsl.as_rgb()
    }
}

impl fmt::Display for RGB {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "\x1B[{}m  \x1B[0m", self.ansi_color_code(TargetGround::Background))     
    }
}

impl ANSIColorCode for RGB {
    fn ansi_color_code(&self, target: TargetGround) -> String {
        format!("{};2;{};{};{}", target.code() + 8, self.r, self.g, self.b)
    }
}

overload::overload!(
    (lhs: ?RGB) + (rhs: ?RGB) -> RGB {
        RGB::new(
            lhs.r.saturating_add(rhs.r),
            lhs.g.saturating_add(rhs.g),
            lhs.b.saturating_add(rhs.b)
        )
    }
);

overload::overload!(
    (lhs: ?RGB) - (rhs: ?RGB) -> RGB {
        RGB::new(
            lhs.r.saturating_sub(rhs.r),
            lhs.g.saturating_sub(rhs.g),
            lhs.b.saturating_sub(rhs.b)
        )
    }
);

overload::overload!(
    (lhs: ?RGB) * (rhs: ?f32) -> RGB {
        RGB::new(
            (lhs.r as f32 * rhs.clamp(0.0, 1.0)) as u8,
            (lhs.g as f32 * rhs.clamp(0.0, 1.0)) as u8,
            (lhs.b as f32 * rhs.clamp(0.0, 1.0)) as u8
        )
    }
);

overload::overload!(
    (lhs: ?f32) * (rhs: ?RGB) -> RGB {
        RGB::new(
            (rhs.r as f32 * lhs.clamp(0.0, 1.0)) as u8,
            (rhs.g as f32 * lhs.clamp(0.0, 1.0)) as u8,
            (rhs.b as f32 * lhs.clamp(0.0, 1.0)) as u8
        )
    }
);

overload::overload!(
    -(rgb: ?RGB) -> RGB {
        RGB::new(
            255 - rgb.r,
            255 - rgb.g,
            255 - rgb.b)
    }
);