termint 0.8.1

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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use std::fmt::Display;

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

/// Style struct containing foreground, background and modifiers
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Style {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub modifier: Modifier,
}

impl Style {
    /// Creates a new [`Style`]
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Resets the [`Style`] to default style
    pub fn reset(&mut self) {
        self.fg = None;
        self.bg = None;
        self.modifier = Modifier::empty();
    }

    /// Sets foreground color to given value
    #[must_use]
    pub fn fg<T>(mut self, fg: T) -> Self
    where
        T: Into<Option<Color>>,
    {
        self.fg = fg.into();
        self
    }

    /// Sets background color to given value
    #[must_use]
    pub fn bg<T>(mut self, bg: T) -> Self
    where
        T: Into<Option<Color>>,
    {
        self.bg = bg.into();
        self
    }

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

    /// Adds given modifier to the already set modifiers
    #[must_use]
    pub fn add_modifier(mut self, flag: Modifier) -> Self {
        self.modifier.insert(flag);
        self
    }

    /// Removes given modifier from the already set modifiers
    #[must_use]
    pub fn remove_modifier(mut self, flag: Modifier) -> Self {
        self.modifier.remove(flag);
        self
    }

    /// Combines two styles, equivalent to applying two styles after each
    /// other. Only modifier gets overriden.
    ///
    /// You can provide any type convertible to [`Style`].
    #[must_use]
    pub fn combine<S>(mut self, other: S) -> Self
    where
        S: Into<Style>,
    {
        let other = other.into();
        self.fg = other.fg.or(self.fg);
        self.bg = other.bg.or(self.bg);
        self.modifier = other.modifier;
        self
    }
}

impl Display for Style {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.modifier)?;
        if let Some(fg) = self.fg {
            write!(f, "{}", fg.to_fg())?;
        }
        if let Some(bg) = self.bg {
            write!(f, "{}", bg.to_bg())?;
        }
        Ok(())
    }
}

impl Default for Style {
    fn default() -> Self {
        Self {
            fg: None,
            bg: None,
            modifier: Modifier::empty(),
        }
    }
}

impl From<Color> for Style {
    /// Creates a new [`Style`] with given foreground color
    fn from(value: Color) -> Self {
        Self::new().fg(value)
    }
}

impl From<(Color, Color)> for Style {
    /// Creates a new [`Style`] with given foreground and background color
    fn from((fg, bg): (Color, Color)) -> Self {
        Self::new().fg(fg).bg(bg)
    }
}

impl From<Modifier> for Style {
    /// Creates a new [`Style`] with given modifier
    fn from(value: Modifier) -> Self {
        Self::new().modifier(value)
    }
}

impl From<(Color, Color, Modifier)> for Style {
    /// Creates a new [`Style`] with given foreground and background color and
    /// with given modifier
    fn from((fg, bg, modifier): (Color, Color, Modifier)) -> Self {
        Self::new().fg(fg).bg(bg).modifier(modifier)
    }
}