ratkit 0.2.16

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
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

#![allow(clippy::as_conversions, clippy::pedantic)]

use compact_str::CompactString;
use unicode_width::UnicodeWidthStr;

/// Represents a single terminal cell.
#[derive(Clone, Debug, Default, Eq)]
pub struct Cell {
    text: CompactString,
    attrs: crate::primitives::termtui::vt100::attrs::Attrs,
}

impl PartialEq<Self> for Cell {
    fn eq(&self, other: &Self) -> bool {
        if self.text != other.text {
            return false;
        }
        if self.attrs != other.attrs {
            return false;
        }
        true
    }
}

impl Cell {
    #[cfg(test)]
    pub fn new(content: &str) -> Cell {
        Cell {
            text: content.into(),
            attrs: Default::default(),
        }
    }

    #[cfg(test)]
    pub fn with_attrs(self, attrs: crate::primitives::termtui::vt100::attrs::Attrs) -> Cell {
        Cell { attrs, ..self }
    }

    pub(crate) fn set(&mut self, c: char, a: crate::primitives::termtui::vt100::attrs::Attrs) {
        self.text.clear();
        self.text.push(c);
        self.attrs = a;
    }

    pub(crate) fn set_str(&mut self, str: &str) {
        self.text.clear();
        self.text.push_str(str);
    }

    pub(crate) fn append(&mut self, c: char) {
        if self.text.is_empty() {
            self.text.push(' ');
        }
        self.text.push(c);
    }

    pub(crate) fn clear(&mut self, attrs: crate::primitives::termtui::vt100::attrs::Attrs) {
        self.text.clear();
        self.attrs = attrs;
    }

    /// Returns the text contents of the cell.
    ///
    /// Can include multiple unicode characters if combining characters are
    /// used, but will contain at most one character with a non-zero character
    /// width.
    #[must_use]
    pub fn contents(&self) -> &str {
        self.text.as_str()
    }

    /// Returns whether the cell contains any text data.
    #[must_use]
    pub fn has_contents(&self) -> bool {
        !self.text.is_empty()
    }

    /// Returns whether the text data in the cell represents a wide character.
    #[must_use]
    pub fn is_wide(&self) -> bool {
        self.text.width() >= 2
    }

    pub fn width(&self) -> u16 {
        self.text.width() as u16
    }

    pub(crate) fn attrs(&self) -> &crate::primitives::termtui::vt100::attrs::Attrs {
        &self.attrs
    }

    pub(crate) fn set_attrs(&mut self, attrs: crate::primitives::termtui::vt100::attrs::Attrs) {
        self.attrs = attrs;
    }
}