fp_tui 0.2.2

A very basic tui library
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

/// #### Description
/// A struct containing the characters that describe a border
/// 
#[derive(Debug, Clone, Copy)]
pub struct BorderStyle {
    /// #### Description
    /// The character that goes on the top and bottom border
    /// 
    horizontal: char,

    /// #### Description
    /// The character that goes on the left and right border
    /// 
    vertical: char,

    /// #### Description
    /// The character that goes in the top left corner
    /// 
    top_left: char,

    /// #### Description
    /// The character that goes in the top right corner
    /// 
    top_right: char,

    /// #### Description
    /// The character that goes in the bottom left corner
    /// 
    bottom_left: char,

    /// #### Description
    /// The character that goes in the bottom right corner
    /// 
    bottom_right: char,
}

impl BorderStyle {
    /// #### Description
    /// Creates a new border style
    /// 
    /// #### Arguments
    /// * `horizontal`: [char] - the top and bottom border
    /// * `vertical`: [char] - the left and right border
    /// * `top_left`: [char] - the top left border
    /// * `top_right`: [char] - the top right border
    /// * `horizontal`: [char] - the bottom left border
    /// * `horizontal`: [char] - the bottom right border
    /// 
    /// #### Returns
    /// [BorderStyle] - A border style with the given characters
    /// 
    pub fn new(
        horizontal: char,
        vertical: char,
        top_left: char,
        top_right: char,
        bottom_left: char,
        bottom_right: char
    ) -> Self {
        return Self {
            horizontal,
            vertical,
            top_left,
            top_right,
            bottom_left,
            bottom_right
        };
    }

    /// #### Description
    /// Retrieves the horizontal border character
    /// 
    /// #### Returns
    /// [char] - The horizontal border character
    /// 
    pub fn get_horizontal(&self) -> char {
        return self.horizontal;
    }

    /// #### Description
    /// Retrieves the vertical border character
    /// 
    /// #### Returns
    /// [char] - The vertical border character
    /// 
    pub fn get_vertical(&self) -> char {
        return self.vertical;
    }

    /// #### Description
    /// Retrieves the top left border character
    /// 
    /// #### Returns
    /// [char] - The top left border character
    /// 
    pub fn get_top_left(&self) -> char {
        return self.top_left;
    }

    /// #### Description
    /// Retrieves the top right border character
    /// 
    /// #### Returns
    /// [char] - The top right border character
    /// 
    pub fn get_top_right(&self) -> char {
        return self.top_right;
    }

    /// #### Description
    /// Retrieves the bottom left border character
    /// 
    /// #### Returns
    /// [char] - The bottom left border character
    /// 
    pub fn get_bottom_left(&self) -> char {
        return self.bottom_left;
    }

    /// #### Description
    /// Retrieves the bottom right border character
    /// 
    /// #### Returns
    /// [char] - The bottom right border character
    /// 
    pub fn get_bottom_right(&self) -> char {
        return self.bottom_right;
    }
}

impl Default for BorderStyle {
    /// #### Description
    /// Creates a border style with the following characters
    /// ─ │ ┌ ┐ └ ┘
    ///
    fn default() -> Self {
        return Self {
            horizontal: '\u{2500}',
            vertical: '\u{2502}',
            top_left: '\u{250C}',
            top_right: '\u{2510}',
            bottom_left: '\u{2514}',
            bottom_right: '\u{2518}'
        }
    }
}