tailspin 6.0.0

A log file highlighter
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
147
148
149
150
151
152
153
154
155
156
157
158

use nu_ansi_term::{Color as NuColor, Style as NuStyle};
use serde::Deserialize;

/// Defines the styling attributes for highlighted text.
///
/// Allows setting foreground (`fg`) and background (`bg`) colors as well as
/// text attributes like bold, italic, faint, and underline.
///
/// Use the provided builder methods for convenient configuration.
///
/// # Examples
///
/// ```rust
/// use tailspin::style::{Style, Color};
///
/// let style = Style::default().fg(Color::Blue).bold();
/// ```
#[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy, Default, Deserialize)]
pub struct Style {
    #[serde(default)]
    pub fg: Option<Color>,
    #[serde(default)]
    pub bg: Option<Color>,
    #[serde(default)]
    pub bold: bool,
    #[serde(default)]
    pub faint: bool,
    #[serde(default)]
    pub italic: bool,
    #[serde(default)]
    pub underline: bool,
}

impl Style {
    #[must_use]
    pub fn new() -> Style {
        Style::default()
    }

    #[must_use]
    pub const fn bold(&self) -> Style {
        Style { bold: true, ..*self }
    }

    #[must_use]
    pub const fn faint(&self) -> Style {
        Style { faint: true, ..*self }
    }

    #[must_use]
    pub const fn italic(&self) -> Style {
        Style { italic: true, ..*self }
    }

    #[must_use]
    pub const fn underline(&self) -> Style {
        Style {
            underline: true,
            ..*self
        }
    }

    #[must_use]
    pub const fn fg(&self, fg: Color) -> Style {
        Style { fg: Some(fg), ..*self }
    }

    #[must_use]
    pub const fn on(&self, bg: Color) -> Style {
        Style { bg: Some(bg), ..*self }
    }
}

/// Available ANSI colors for terminal output.
///
/// Includes standard and bright variants.
///
/// # Examples
///
/// ```rust
/// use tailspin::style::Color;
///
/// let cyan = Color::Cyan;
/// ```
#[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy, Default, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Color {
    #[default]
    Default,
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
    BrightBlack,
    BrightRed,
    BrightGreen,
    BrightYellow,
    BrightBlue,
    BrightMagenta,
    BrightCyan,
    BrightWhite,
}

impl From<Color> for NuColor {
    fn from(color: Color) -> Self {
        match color {
            Color::Default => NuColor::Default,
            Color::Black => NuColor::Black,
            Color::Red => NuColor::Red,
            Color::Green => NuColor::Green,
            Color::Yellow => NuColor::Yellow,
            Color::Blue => NuColor::Blue,
            Color::Magenta => NuColor::Magenta,
            Color::Cyan => NuColor::Cyan,
            Color::White => NuColor::White,
            Color::BrightBlack => NuColor::DarkGray,
            Color::BrightRed => NuColor::LightRed,
            Color::BrightGreen => NuColor::LightGreen,
            Color::BrightYellow => NuColor::LightYellow,
            Color::BrightBlue => NuColor::LightBlue,
            Color::BrightMagenta => NuColor::LightMagenta,
            Color::BrightCyan => NuColor::LightCyan,
            Color::BrightWhite => NuColor::LightGray,
        }
    }
}

impl From<Style> for NuStyle {
    fn from(style: Style) -> Self {
        let mut nu_style = NuStyle::new();

        if let Some(fg) = style.fg {
            nu_style = nu_style.fg(NuColor::from(fg));
        }
        if let Some(bg) = style.bg {
            nu_style = nu_style.on(NuColor::from(bg));
        }

        if style.bold {
            nu_style = nu_style.bold();
        }
        if style.faint {
            nu_style = nu_style.dimmed();
        }
        if style.italic {
            nu_style = nu_style.italic();
        }
        if style.underline {
            nu_style = nu_style.underline();
        }

        nu_style
    }
}