logkit 0.3.7

Super fast, structured, scalable logging library for Rust
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

//! Record represent a single log entry
use super::define::*;
use super::source::*;

/// Log Record
///
/// Each log is represented as a record, primarily utilized by the Logger. The Logger is responsible
/// for spawning the record, invoking plugin methods, and calling target methods on it. After use,
/// the record is recycled by the Logger to minimize allocation and enhance the speed of future
/// record creation.
#[derive(Debug, Clone)]
pub struct Record {
    level: Level,
    buffer: Vec<u8>,
    source: Source,
}

impl Record {
    /// Create a new record
    ///
    /// ```
    /// let mut record = logkit::Record::new(logkit::LEVEL_TRACE, logkit::source!());
    /// assert_eq!(record.level(), logkit::LEVEL_TRACE);
    /// ```
    #[inline]
    pub fn new(level: Level, source: Source) -> Self {
        let mut obj = Self {level, buffer: vec![], source};
        obj.buffer.push(b'{');
        obj
    }

    /// Reset record for reuse
    ///
    /// ```
    /// let mut record = logkit::Record::new(logkit::LEVEL_TRACE, logkit::source!());
    /// assert_eq!(record.level(), logkit::LEVEL_TRACE);
    ///
    /// record = logkit::Record::set(record, logkit::LEVEL_ERROR, logkit::source!());
    /// assert_eq!(record.level(), logkit::LEVEL_ERROR);
    /// ```
    #[inline]
    pub fn set(mut record: Record, level: Level, source: Source) -> Self {
        record.level = level;
        record.buffer.truncate(1); // preserve '{'
        record.source = source;
        record
    }

    /// Current record's log level
    #[inline]
    pub fn level(&self) -> Level {
        self.level
    }

    /// Current record's source info
    #[inline]
    pub fn source(&self) -> &Source {
        &self.source
    }

    /// Append field's key and value to record
    ///
    /// The order of fields is fixed, fields are stored in the order they are added.
    ///
    /// Note that duplicate fields are not filtered out.
    ///
    /// ```
    /// let mut record = logkit::Record::new(logkit::LEVEL_TRACE, logkit::source!());
    /// record.append("pid", &12345);
    /// record.append("msg", &"think outside the box");
    /// record.finish();
    /// assert_eq!(String::from_utf8_lossy(record.buffer().as_slice()), "{\"pid\":12345,\"msg\":\"think outside the box\"}\n");
    /// ```
    #[inline]
    pub fn append(&mut self, key: &str, val: &impl Encode) -> &mut Self {
        key.encode(&mut self.buffer);
        self.buffer.push(b':');
        val.encode(&mut self.buffer);
        self.buffer.push(b',');
        self
    }

    /// Mark the end of the record
    ///
    /// ```
    /// let mut record = logkit::Record::new(logkit::LEVEL_TRACE, logkit::source!());
    /// record.finish();
    /// assert_eq!(String::from_utf8_lossy(record.buffer().as_slice()), "{}\n");
    /// ```
    #[inline]
    pub fn finish(&mut self) {
        match self.buffer.last_mut() {
            Some(val) if *val == b',' => *val = b'}',
            _ => self.buffer.push(b'}'),
        }

        self.buffer.push(b'\n');
    }

    /// Get the final buffer
    ///
    /// ```
    /// let mut record = logkit::Record::new(logkit::LEVEL_TRACE, logkit::source!());
    /// record.append("msg", &"less is more");
    /// record.finish();
    /// assert_eq!(String::from_utf8_lossy(record.buffer().as_slice()), "{\"msg\":\"less is more\"}\n");
    /// ```
    #[inline]
    pub fn buffer(&self) -> &Vec<u8> {
        &self.buffer
    }
}