btui 0.6.12

make simple beautiful text user interfaces with btui
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

/// module containing enums to represent terminal effects
pub mod effects {
    /// enum to represent any color
    pub enum Color {
        Black,
        Red,
        Green,
        Yellow,
        Blue,
        Magenta,
        Cyan,
        White,
        /// set color to an rgb color
        RGB(u8, u8, u8),
    }

    /// enum to represent special printings other than colors
    pub enum Special {
        Bold,
        Underline,
        Stroke,
        Italic,
        /// reset all graphical effects
        Reset,
    }
}

/// module for giving printable escape sequences
pub mod print {
    use crate::effects::Color;
    use crate::effects::Special;

    /// change foreground color
    ///
    /// # Arguments
    /// *`col`: color to use
    ///
    /// # Returns
    /// the color code to be printed to the terminal
    ///
    /// # Example
    /// ```rust
    /// use btui::print::fg;
    /// use btui::effects::Color;
    /// println!("{}test", fg(Color::Red));
    /// ```
    pub fn fg(col: Color) -> String {
        match col {
            Color::Black => String::from("\x1b[30m"),
            Color::Red => String::from("\x1b[31m"),
            Color::Green => String::from("\x1b[32m"),
            Color::Yellow => String::from("\x1b[33m"),
            Color::Blue => String::from("\x1b[34m"),
            Color::Magenta => String::from("\x1b[35m"),
            Color::Cyan => String::from("\x1b[36m"),
            Color::White => String::from("\x1b[37m"),
            Color::RGB(r, g, b) => format!("\x1b[38;2;{};{};{}m", r, g, b),
        }
    }

    /// change background color
    ///
    /// # Arguments
    /// *`col`: color to use
    ///
    /// # Returns
    /// the color code to be printed to the terminal
    ///
    /// # Example
    /// ```rust
    /// use btui::print::bg;
    /// use btui::effects::Color;
    /// println!("{}test", bg(Color::Red));
    /// ```
    pub fn bg(col: Color) -> String {
        match col {
            Color::Black => String::from("\x1b[40m"),
            Color::Red => String::from("\x1b[41m"),
            Color::Green => String::from("\x1b[42m"),
            Color::Yellow => String::from("\x1b[43m"),
            Color::Blue => String::from("\x1b[44m"),
            Color::Magenta => String::from("\x1b[45m"),
            Color::Cyan => String::from("\x1b[46m"),
            Color::White => String::from("\x1b[47m"),
            Color::RGB(r, g, b) => format!("\x1b[48;2;{};{};{}m", r, g, b),
        }
    }

    /// apply a special effect
    ///
    /// # Arguments
    /// *`special`: effect to apply
    ///
    /// # Returns
    /// a string containing the escape sequence to use
    ///
    /// # Example
    /// ```rust
    /// use btui::effects::Special;
    /// use btui::print::sp;
    /// println!("{}test{}", sp(Special::Underline), sp(Special::Reset));
    /// ```
    pub fn sp(special: Special) -> String {
        match special {
            Special::Bold => String::from("\x1b[1m"),
            Special::Underline => String::from("\x1b[4m"),
            Special::Stroke => String::from("\x1b[9m"),
            Special::Italic => String::from("\x1b[3m"),
            Special::Reset => String::from("\x1b[0m"),
        }
    }
}