ratatui-core 0.1.0

Core types and traits for the Ratatui Terminal UI library. Widget libraries should use this crate. Applications should use the main Ratatui crate.
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

//! Conversions from colors in the `palette` crate to [`Color`].

use ::palette::LinSrgb;
use ::palette::bool_mask::LazySelect;
use ::palette::num::{Arithmetics, MulSub, PartialCmp, Powf, Real};
use palette::Srgb;
use palette::stimulus::IntoStimulus;

use crate::style::Color;

/// Convert an [`palette::Srgb`] color to a [`Color`].
///
/// # Examples
///
/// ```
/// use palette::Srgb;
/// use ratatui_core::style::Color;
///
/// let color = Color::from(Srgb::new(1.0f32, 0.0, 0.0));
/// assert_eq!(color, Color::Rgb(255, 0, 0));
/// ```
impl<T: IntoStimulus<u8>> From<Srgb<T>> for Color {
    fn from(color: Srgb<T>) -> Self {
        let (red, green, blue) = color.into_format().into_components();
        Self::Rgb(red, green, blue)
    }
}

/// Convert a [`palette::LinSrgb`] color to a [`Color`].
///
/// Note: this conversion only works for floating point linear sRGB colors. If you have a linear
/// sRGB color in another format, you need to convert it to floating point first.
///
/// # Examples
///
/// ```
/// use palette::LinSrgb;
/// use ratatui_core::style::Color;
///
/// let color = Color::from(LinSrgb::new(1.0f32, 0.0, 0.0));
/// assert_eq!(color, Color::Rgb(255, 0, 0));
/// ```
impl<T: IntoStimulus<u8>> From<LinSrgb<T>> for Color
where
    T: Real + Powf + MulSub + Arithmetics + PartialCmp + Clone,
    T::Mask: LazySelect<T>,
{
    fn from(color: LinSrgb<T>) -> Self {
        let srgb_color = Srgb::<T>::from_linear(color);
        Self::from(srgb_color)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn from_srgb() {
        const RED: Color = Color::Rgb(255, 0, 0);
        assert_eq!(Color::from(Srgb::new(255u8, 0, 0)), RED);
        assert_eq!(Color::from(Srgb::new(65535u16, 0, 0)), RED);
        assert_eq!(Color::from(Srgb::new(1.0f32, 0.0, 0.0)), RED);

        assert_eq!(
            Color::from(Srgb::new(0.5f32, 0.5, 0.5)),
            Color::Rgb(128, 128, 128)
        );
    }

    #[test]
    fn from_lin_srgb() {
        const RED: Color = Color::Rgb(255, 0, 0);
        assert_eq!(Color::from(LinSrgb::new(1.0f32, 0.0, 0.0)), RED);
        assert_eq!(Color::from(LinSrgb::new(1.0f64, 0.0, 0.0)), RED);

        assert_eq!(
            Color::from(LinSrgb::new(0.5f32, 0.5, 0.5)),
            Color::Rgb(188, 188, 188)
        );
    }
}