lunatic-log 0.4.0

A logging library for lunatic Rust applications
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

use serde::{Deserialize, Serialize};

use crate::level::Level;

/// Metadata describing an [Event](super::Event).
///
/// All events have the following metadata:
/// - A [name], represented as a static string.
/// - A [target], a string that categorizes part of the system where the event
///   or event occurred. The macros default to using the module
///   path where the event or event originated as the target, but it may be
///   overridden.
/// - A [verbosity level]. This determines how verbose a given event
///   is, and allows enabling or disabling more verbose diagnostics
///   situationally. See the documentation for the [`Level`] type for details.
/// - The names of the [fields] defined by the event.
/// - Whether the metadata corresponds to a event.
///
/// In addition, the following optional metadata describing the source code
/// location where the event originated _may_ be provided:
/// - The [file name]
/// - The [line number]
/// - The [module path]
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Metadata {
    /// The name of the event described by this metadata.
    name: String,

    /// The part of the system that the event that this metadata describes
    /// occurred in.
    target: String,

    /// The level of verbosity of the described event.
    level: Level,

    /// The name of the Rust module where the event occurred, or `None` if this
    /// could not be determined.
    module_path: Option<String>,

    /// The name of the source code file where the event occurred, or `None` if
    /// this could not be determined.
    file: Option<String>,

    /// The line number in the source code file where the event occurred, or
    /// `None` if this could not be determined.
    line: Option<u32>,
}

impl Metadata {
    /// Construct new metadata for a event, with a name, target, level, field
    /// names, and optional source code location.
    pub const fn new(
        name: String,
        target: String,
        level: Level,
        module_path: Option<String>,
        file: Option<String>,
        line: Option<u32>,
    ) -> Self {
        Metadata {
            name,
            target,
            level,
            module_path,
            file,
            line,
        }
    }

    /// Returns the level of verbosity of the described span or event.
    pub fn level(&self) -> &Level {
        &self.level
    }

    /// Returns the name of the span.
    pub fn name(&self) -> &String {
        &self.name
    }

    /// Returns a string describing the part of the system where the span or
    /// event that this metadata describes occurred.
    ///
    /// Typically, this is the module path, but alternate targets may be set
    /// when spans or events are constructed.
    pub fn target(&self) -> &String {
        &self.target
    }

    /// Returns the path to the Rust module where the span occurred, or
    /// `None` if the module path is unknown.
    pub fn module_path(&self) -> Option<&String> {
        self.module_path.as_ref()
    }

    /// Returns the name of the source code file where the span
    /// occurred, or `None` if the file is unknown
    pub fn file(&self) -> Option<&String> {
        self.file.as_ref()
    }

    /// Returns the line number in the source code file where the span
    /// occurred, or `None` if the line number is unknown.
    pub fn line(&self) -> Option<u32> {
        self.line
    }
}