termint 0.8.0

Library for colored printing and Terminal User Interfaces
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

use std::fmt::Display;

use compact_str::{CompactString, ToCompactString};

use crate::{
    enums::{Color, Modifier},
    style::Style,
};

/// A buffer cell containing foreground, background, modifiers and symbol.
#[derive(Debug, Clone, PartialEq)]
pub struct Cell {
    pub fg: Color,
    pub bg: Color,
    pub modifier: Modifier,
    pub val: CompactString,
}

impl Cell {
    /// Creates new [`Cell`] with given value
    pub fn new(val: &'static str) -> Self {
        Self {
            val: CompactString::const_new(val),
            ..Default::default()
        }
    }

    /// Creates empty [`Cell`]
    pub fn empty() -> Self {
        Self::default()
    }

    /// Sets value of the [`Cell`]
    pub fn val(&mut self, val: &str) -> &mut Self {
        self.val = CompactString::new(val);
        self
    }

    /// Sets value of the [`Cell`] to given char
    pub fn char(&mut self, c: char) -> &mut Self {
        self.val = c.to_compact_string();
        self
    }

    /// Sets [`Cell`] foreground color to given value
    pub fn fg(&mut self, fg: Color) -> &mut Self {
        self.fg = fg;
        self
    }

    /// Sets [`Cell`] background color to given value
    pub fn bg(&mut self, bg: Color) -> &mut Self {
        self.bg = bg;
        self
    }

    /// Sets [`Cell`] modifier to the given flag
    pub fn modifier(&mut self, flag: Modifier) -> &mut Self {
        self.modifier = Modifier::empty();
        self.modifier.insert(flag);
        self
    }

    /// Sets style of the [`Cell`] to the given value. If `fg` or `bg` are
    /// none, it keeps the original value.
    pub fn style<T>(&mut self, style: T) -> &mut Self
    where
        T: Into<Style>,
    {
        let style = style.into();
        if let Some(fg) = style.fg {
            self.fg = fg;
        }
        if let Some(bg) = style.bg {
            self.bg = bg;
        }
        self.modifier = style.modifier;
        self
    }

    /// Resets the [`Cell`] to defalt values
    pub fn reset(&mut self) {
        self.fg = Color::Default;
        self.bg = Color::Default;
        self.modifier = Modifier::empty();
        self.val = CompactString::const_new(" ");
    }
}

impl Display for Cell {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}{}{}{}",
            self.modifier,
            self.fg.to_fg(),
            self.bg.to_bg(),
            self.val
        )
    }
}

impl Default for Cell {
    fn default() -> Self {
        Self {
            fg: Color::Default,
            bg: Color::Default,
            modifier: Modifier::empty(),
            val: CompactString::const_new(" "),
        }
    }
}