uzor-tui 1.0.3

Terminal UI backend for uzor
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

//! Terminal cell: single character + style.
//!
//! Uses `CompactString` instead of `String` for the symbol field to avoid
//! heap allocation. Terminal cell symbols are almost always 1-4 bytes
//! (single ASCII or small Unicode), which `CompactString` stores inline
//! (up to ~24 bytes on 64-bit). This eliminates ~3840 heap allocations
//! for a typical 80x24 double-buffered terminal.

use compact_str::CompactString;
use crate::style::Style;

/// A single terminal cell.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Cell {
    /// The grapheme displayed in this cell (usually 1 char).
    ///
    /// Stored as `CompactString` to avoid heap allocation for short symbols.
    pub symbol: CompactString,
    /// Visual style.
    pub style: Style,
}

impl Default for Cell {
    fn default() -> Self {
        Self {
            symbol: CompactString::const_new(" "),
            style: Style::default(),
        }
    }
}

impl Cell {
    /// Create a cell with a symbol and default style.
    pub fn new(symbol: impl Into<CompactString>) -> Self {
        Self {
            symbol: symbol.into(),
            style: Style::default(),
        }
    }

    /// Create a cell with symbol and style.
    pub fn styled(symbol: impl Into<CompactString>, style: Style) -> Self {
        Self {
            symbol: symbol.into(),
            style,
        }
    }

    /// Reset to default (space with no style).
    pub fn reset(&mut self) {
        self.symbol = CompactString::const_new(" ");
        self.style = Style::default();
    }
}