fast-rich 0.3.2

A Rust port of Python's Rich library for beautiful terminal formatting
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

//! Measure API for calculating renderable dimensions.
//!
//! Allows measuring how a renderable will be rendered without actually rendering it.

use crate::console::RenderContext;
use crate::renderable::Renderable;

/// Measurement of a renderable's dimensions.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Measurement {
    /// Minimum width required
    pub minimum: usize,
    /// Maximum width that will be used
    pub maximum: usize,
    /// Number of lines when rendered
    pub lines: usize,
}

impl Measurement {
    /// Create a new measurement.
    pub fn new(minimum: usize, maximum: usize, lines: usize) -> Self {
        Measurement {
            minimum,
            maximum,
            lines,
        }
    }

    /// Measure a renderable at a given width.
    pub fn measure(renderable: &impl Renderable, width: usize) -> Self {
        let context = RenderContext {
            width,
            height: None,
        };
        let segments = renderable.render(&context);

        let lines = segments.len();
        let minimum = renderable.min_width();
        let maximum = renderable.max_width().min(width);

        Measurement {
            minimum,
            maximum,
            lines,
        }
    }

    /// Get the aspect ratio (width / height).
    pub fn aspect_ratio(&self) -> f64 {
        if self.lines == 0 {
            0.0
        } else {
            self.maximum as f64 / self.lines as f64
        }
    }

    /// Check if the measurement fits within given dimensions.
    pub fn fits(&self, width: usize, height: usize) -> bool {
        self.minimum <= width && self.lines <= height
    }

    /// Get the total area (width * height).
    pub fn area(&self) -> usize {
        self.maximum * self.lines
    }
}

/// Helper trait for measuring renderables.
pub trait Measurable {
    /// Measure this renderable at the given width.
    fn measure(&self, width: usize) -> Measurement;
}

impl<T: Renderable> Measurable for T {
    fn measure(&self, width: usize) -> Measurement {
        Measurement::measure(self, width)
    }
}

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

    #[test]
    fn test_measurement_creation() {
        let m = Measurement::new(10, 50, 3);
        assert_eq!(m.minimum, 10);
        assert_eq!(m.maximum, 50);
        assert_eq!(m.lines, 3);
    }

    #[test]
    fn test_measure_text() {
        let text = Text::plain("Hello, World!");
        let m = Measurement::measure(&text, 80);

        assert!(m.minimum > 0);
        assert!(m.lines > 0);
    }

    #[test]
    fn test_aspect_ratio() {
        let m = Measurement::new(20, 40, 5);
        assert_eq!(m.aspect_ratio(), 8.0);
    }

    #[test]
    fn test_fits() {
        let m = Measurement::new(10, 40, 3);
        assert!(m.fits(50, 5));
        assert!(!m.fits(5, 5)); // Too narrow
        assert!(!m.fits(50, 2)); // Too short
    }

    #[test]
    fn test_area() {
        let m = Measurement::new(10, 20, 5);
        assert_eq!(m.area(), 100); // 20 * 5
    }
}