mural 0.1.0

Conversational terminal rendering for command-line applications.
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

use super::{Color, Modifiers};

/// Style attributes applied to a [`Span`](crate::Span).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct Style {
    fg: Option<Color>,
    bg: Option<Color>,
    modifiers: Modifiers,
}

impl Style {
    /// Creates the default style.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the foreground color.
    pub fn fg(mut self, color: Color) -> Self {
        self.fg = Some(color);
        self
    }

    /// Sets the background color.
    pub fn bg(mut self, color: Color) -> Self {
        self.bg = Some(color);
        self
    }

    /// Adds the bold modifier.
    pub fn bold(mut self) -> Self {
        self.modifiers.insert(Modifiers::BOLD);
        self
    }

    /// Adds the dim modifier.
    pub fn dim(mut self) -> Self {
        self.modifiers.insert(Modifiers::DIM);
        self
    }

    /// Adds the italic modifier.
    pub fn italic(mut self) -> Self {
        self.modifiers.insert(Modifiers::ITALIC);
        self
    }

    /// Adds the underline modifier.
    pub fn underline(mut self) -> Self {
        self.modifiers.insert(Modifiers::UNDERLINE);
        self
    }

    /// Adds the reversed foreground/background modifier.
    pub fn reversed(mut self) -> Self {
        self.modifiers.insert(Modifiers::REVERSED);
        self
    }

    /// Adds the given modifier.
    pub fn modifier(mut self, modifier: Modifiers) -> Self {
        self.modifiers.insert(modifier);
        self
    }

    /// Overlays another style on this style.
    ///
    /// Foreground/background colors from `overlay` replace existing colors when set;
    /// modifiers are unioned.
    pub fn overlay(mut self, overlay: Style) -> Self {
        if let Some(color) = overlay.fg {
            self.fg = Some(color);
        }
        if let Some(color) = overlay.bg {
            self.bg = Some(color);
        }
        self.modifiers.insert(overlay.modifiers);
        self
    }

    /// Returns the foreground color, if any.
    pub fn foreground(&self) -> Option<Color> {
        self.fg
    }

    /// Returns the background color, if any.
    pub fn background(&self) -> Option<Color> {
        self.bg
    }

    pub(crate) fn is_plain(&self) -> bool {
        self.fg.is_none() && self.bg.is_none() && self.modifiers.is_empty()
    }

    /// Returns the active style modifiers.
    pub fn modifiers(&self) -> Modifiers {
        self.modifiers
    }
}