boxx 0.0.1-alpha

Display informational boxes in the terminal.
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

use crate::BorderStyle;

/// `BorderComponents` defines the `String` to use when dislaying
/// the border of a `Boxx`
#[derive(Clone, PartialEq, Debug)]
pub struct BorderComponents {
    /// `String` to display as the top left corner of a `Boxx` border
    /// This should be one visual character wide
    pub top_left: String,

    /// `String` to repeat as the top and bottom of a `Boxx` border
    pub horizontal: String,

    /// `String` to display as the top right corner of a `Boxx` border
    /// This should be one visual character wide
    pub top_right: String,

    /// `String` to repeat as the left and right of a `Boxx` border
    pub vertical: String,

    /// `String` to display as the bottom right corner of a `Boxx` border
    /// This should be one visual character wide
    pub bottom_right: String,

    /// `String` to display as the bottom left corner of a `Boxx` border
    /// This should be one visual character wide
    pub bottom_left: String,
}

impl BorderComponents {
    /// Creates new `BorderComponents` from a `BorderStyle`
    pub fn new(style: BorderStyle) -> BorderComponents {
        match style {
            BorderStyle::Single => BorderComponents {
                top_left: "┌".to_string(),
                top_right: "┐".to_string(),
                bottom_right: "┘".to_string(),
                bottom_left: "└".to_string(),
                vertical: "│".to_string(),
                horizontal: "─".to_string(),
            },
            BorderStyle::Double => BorderComponents {
                top_left: "╔".to_string(),
                top_right: "╗".to_string(),
                bottom_right: "╝".to_string(),
                bottom_left: "╚".to_string(),
                vertical: "║".to_string(),
                horizontal: "═".to_string(),
            },
            BorderStyle::Round => BorderComponents {
                top_left: "╭".to_string(),
                top_right: "╮".to_string(),
                bottom_right: "╯".to_string(),
                bottom_left: "╰".to_string(),
                vertical: "│".to_string(),
                horizontal: "─".to_string(),
            },
            BorderStyle::Bold => BorderComponents {
                top_left: "┏".to_string(),
                top_right: "┓".to_string(),
                bottom_right: "┛".to_string(),
                bottom_left: "┗".to_string(),
                vertical: "┃".to_string(),
                horizontal: "━".to_string(),
            },
            BorderStyle::SingleDouble => BorderComponents {
                top_left: "╓".to_string(),
                top_right: "╖".to_string(),
                bottom_right: "╜".to_string(),
                bottom_left: "╙".to_string(),
                vertical: "║".to_string(),
                horizontal: "─".to_string(),
            },
            BorderStyle::DoubleSingle => BorderComponents {
                top_left: "╒".to_string(),
                top_right: "╕".to_string(),
                bottom_right: "╛".to_string(),
                bottom_left: "╘".to_string(),
                vertical: "│".to_string(),
                horizontal: "═".to_string(),
            },
            BorderStyle::Classic => BorderComponents {
                top_left: "+".to_string(),
                top_right: "+".to_string(),
                bottom_right: "+".to_string(),
                bottom_left: "+".to_string(),
                vertical: "|".to_string(),
                horizontal: "-".to_string(),
            },
            BorderStyle::Custom(components) => components,
        }
    }
}