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
119
120
121
122
123
124
125
126
127
128

use crate::printer::{Printable, Printer};

pub use code::*;
pub use header::*;
pub use note::*;
pub use prefix::*;
pub use separator::*;
pub use stack::*;
pub use stack_trace::*;
pub use step::*;
pub use text::*;

mod code;
mod header;
mod note;
mod prefix;
mod separator;
mod stack;
mod stack_trace;
mod step;
mod text;

/// A block log.
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone)]
pub enum LogBlock<'a> {
    // Basic blocks.
    Text(TextBlock<'a>),
    Prefix(PrefixBlock<'a>),

    // Custom blocks.
    Separator(SeparatorBlock),
    Header(HeaderBlock<'a>),
    Note(NoteBlock<'a>),
    Stack(StackBlock<'a>),
    Code(CodeBlock<'a>),
    Steps(StepsBlock<'a>),
}

impl<'a> LogBlock<'a> {
    // METHODS ----------------------------------------------------------------

    /// Makes this type owned, i.e. changing the lifetime to `'static`.
    pub fn make_owned(self) -> LogBlock<'static> {
        match self {
            // Basic blocks.
            LogBlock::Text(v) => LogBlock::Text(v.make_owned()),
            LogBlock::Prefix(v) => LogBlock::Prefix(v.make_owned()),

            // Custom blocks.
            LogBlock::Separator(v) => LogBlock::Separator(v),
            LogBlock::Header(v) => LogBlock::Header(v.make_owned()),
            LogBlock::Note(v) => LogBlock::Note(v.make_owned()),
            LogBlock::Stack(v) => LogBlock::Stack(v.make_owned()),
            LogBlock::Code(v) => LogBlock::Code(v.make_owned()),
            LogBlock::Steps(v) => LogBlock::Steps(v.make_owned()),
        }
    }
}

impl<'a> Printable<'a> for LogBlock<'a> {
    fn print<'s>(&'s self, printer: &mut Printer<'a>)
    where
        'a: 's,
    {
        match self {
            // Basic blocks.
            LogBlock::Text(v) => v.print(printer),
            LogBlock::Prefix(v) => v.print(printer),

            // Custom blocks.
            LogBlock::Separator(v) => v.print(printer),
            LogBlock::Header(v) => v.print(printer),
            LogBlock::Note(v) => v.print(printer),
            LogBlock::Stack(v) => v.print(printer),
            LogBlock::Code(v) => v.print(printer),
            LogBlock::Steps(v) => v.print(printer),
        }
    }
}

impl<'a> From<TextBlock<'a>> for LogBlock<'a> {
    fn from(block: TextBlock<'a>) -> Self {
        LogBlock::Text(block)
    }
}

impl<'a> From<PrefixBlock<'a>> for LogBlock<'a> {
    fn from(block: PrefixBlock<'a>) -> Self {
        LogBlock::Prefix(block)
    }
}

impl<'a> From<SeparatorBlock> for LogBlock<'a> {
    fn from(block: SeparatorBlock) -> Self {
        LogBlock::Separator(block)
    }
}

impl<'a> From<HeaderBlock<'a>> for LogBlock<'a> {
    fn from(block: HeaderBlock<'a>) -> Self {
        LogBlock::Header(block)
    }
}

impl<'a> From<NoteBlock<'a>> for LogBlock<'a> {
    fn from(block: NoteBlock<'a>) -> Self {
        LogBlock::Note(block)
    }
}

impl<'a> From<StackBlock<'a>> for LogBlock<'a> {
    fn from(block: StackBlock<'a>) -> Self {
        LogBlock::Stack(block)
    }
}

impl<'a> From<CodeBlock<'a>> for LogBlock<'a> {
    fn from(block: CodeBlock<'a>) -> Self {
        LogBlock::Code(block)
    }
}

impl<'a> From<StepsBlock<'a>> for LogBlock<'a> {
    fn from(block: StepsBlock<'a>) -> Self {
        LogBlock::Steps(block)
    }
}