doclog 0.3.0

A Rust log library based on Rust's compiler logs
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

use crate::blocks::TextBlock;
use crate::printer::{Printable, Printer, PrinterFormat};
use crate::{LogContent, LogLevel};
use std::fmt::Display;

/// Prints any content prefixed with a text block.
///
/// When printed, prefix will get all newline characters `\n`
/// replaced by whitespaces to only occupy one line.
#[derive(Default, Debug, Clone)]
pub struct PrefixBlock<'a> {
    pub prefix: TextBlock<'a>,
    pub content: Box<LogContent<'a>>,
}

impl<'a> PrefixBlock<'a> {
    // CONSTRUCTORS -----------------------------------------------------------

    /// Creates a new empty [PrefixBlock].
    #[inline(always)]
    pub fn new() -> Self {
        Self::default()
    }

    // BUILDERS ---------------------------------------------------------------

    /// Sets the prefix.
    #[inline(always)]
    pub fn prefix(mut self, prefix: impl Into<TextBlock<'a>>) -> Self {
        self.prefix = prefix.into();
        self
    }

    /// Sets the inner content.
    #[inline(always)]
    pub fn content(mut self, content: LogContent<'a>) -> Self {
        self.content = Box::new(content);
        self
    }

    // METHODS ----------------------------------------------------------------

    /// Makes this type owned, i.e. changing the lifetime to `'static`.
    pub fn make_owned(self) -> PrefixBlock<'static> {
        PrefixBlock {
            prefix: self.prefix.make_owned(),
            content: Box::new(self.content.make_owned()),
        }
    }
}

impl<'a> Printable<'a> for PrefixBlock<'a> {
    fn print<'s>(&'s self, printer: &mut Printer<'a>)
    where
        'a: 's,
    {
        let mut content_printer = printer.derive();
        self.content.print(&mut content_printer);

        let prefix = self.prefix.single_lined();
        content_printer.indent(&prefix.sections, true);
        printer.append(content_printer);
    }
}

impl<'a> Display for PrefixBlock<'a> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut printer = Printer::new(LogLevel::trace(), PrinterFormat::Plain);
        self.print(&mut printer);
        printer.fmt(f, PrinterFormat::Plain)
    }
}

// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use crate::blocks::{PrefixBlock, TextBlock};
    use crate::printer::{Printable, PrinterFormat};
    use crate::{LogContent, LogLevel};
    use yansi::Style;

    #[test]
    fn test_plain() {
        let log = PrefixBlock::new()
            .prefix(TextBlock::new().add_styled_text(" |\n-> ", Style::new().bold().blue()))
            .content(
                LogContent::new().add_block(TextBlock::new().add_styled_text(
                    "The message\nin\nmultiple\nlines",
                    Style::new().bold().red(),
                )),
            );
        let text = log.print_to_string(LogLevel::error(), PrinterFormat::Plain);

        assert_eq!(
            text,
            " | -> The message\n | -> in\n | -> multiple\n | -> lines"
        );
    }

    #[test]
    fn test_styled() {
        let log = PrefixBlock::new()
            .prefix(TextBlock::new().add_styled_text(" |\n-> ", Style::new().bold().blue()))
            .content(
                LogContent::new().add_block(TextBlock::new().add_styled_text(
                    "The message\nin\nmultiple\nlines",
                    Style::new().bold().red(),
                )),
            );
        let text = log.print_to_string(LogLevel::error(), PrinterFormat::Styled);

        println!("{}", text);
        assert_eq!(text, "\u{1b}[1;34m | -> \u{1b}[0m\u{1b}[1;31mThe message\n\u{1b}[0m\u{1b}[1;34m | -> \u{1b}[0m\u{1b}[1;31min\n\u{1b}[0m\u{1b}[1;34m | -> \u{1b}[0m\u{1b}[1;31mmultiple\n\u{1b}[0m\u{1b}[1;34m | -> \u{1b}[0m\u{1b}[1;31mlines\u{1b}[0m");
    }
}