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

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

/// A block that prints a note, i.e. a text prefixed by an equal sign.
///
/// # Examples
/// ```text
/// = <text>
/// ```
#[derive(Default, Debug, Clone, Eq, PartialEq)]
pub struct NoteBlock<'a> {
    pub text: TextBlock<'a>,
}

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

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

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

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

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

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

impl<'a> Printable<'a> for NoteBlock<'a> {
    fn print<'s>(&'s self, printer: &mut Printer<'a>)
    where
        'a: 's,
    {
        printer.push_styled_text("= ", Style::new().bold().fg(printer.level.color()));
        self.text.print(printer);
    }
}

impl<'a> Display for NoteBlock<'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 yansi::Style;

    use crate::LogLevel;

    use super::*;

    #[test]
    fn test_plain() {
        let log = NoteBlock::new()
            .text(TextBlock::new().add_styled_text("NOTE", Style::new().underline().yellow()));
        let text = log.print_to_string(LogLevel::error(), PrinterFormat::Plain);

        assert_eq!(text, "= NOTE");
    }

    #[test]
    fn test_styled() {
        let log = NoteBlock::new()
            .text(TextBlock::new().add_styled_text("NOTE", Style::new().underline().yellow()));
        let text = log.print_to_string(LogLevel::error(), PrinterFormat::Styled);

        println!("{}", text);
        assert_eq!(text, "\u{1b}[1;31m= \u{1b}[0m\u{1b}[4;33mNOTE\u{1b}[0m");
    }
}