witchcraft-log 5.0.0

A structured logging facade for Witchcraft servers
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

// Copyright 2019 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/// Logs a message at the specified level.
#[macro_export]
macro_rules! log {
    ($lvl:expr, $msg:expr) => {{
        let level = $lvl;
        if level <= $crate::max_level() {
            $crate::private::log_minimal(
                level,
                &(module_path!(), file!(), line!(), $msg),
            );
        }
    }};
    (
        $lvl:expr,
        $msg:expr
        $(, safe: { $($safe_key:ident: $safe_value:expr),* $(,)? })?
        $(, unsafe: { $($unsafe_key:ident: $unsafe_value:expr),* $(,)? })?
        $(, error: $error:expr)?
        $(,)?
    ) => {{
        let level = $lvl;
        if level <= $crate::max_level() {
            $crate::private::log(
                level,
                &(module_path!(), file!(), line!(), $msg),
                &[$($((stringify!($safe_key), &$safe_value)),*)*],
                &[$($((stringify!($unsafe_key), &$unsafe_value)),*)*],
                None $(.or(Some(&$error)))?,
            );
        }
    }};
}

/// Logs a message at the "fatal" level.
#[macro_export]
macro_rules! fatal {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Fatal, $($v)*)
    }
}

/// Logs a message at the "error" level.
#[macro_export]
macro_rules! error {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Error, $($v)*)
    }
}

/// Logs a message at the "warn" level.
#[macro_export]
macro_rules! warn {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Warn, $($v)*)
    }
}

/// Logs a message at the "info" level.
#[macro_export]
macro_rules! info {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Info, $($v)*)
    }
}

/// Logs a message at the "debug" level.
#[macro_export]
macro_rules! debug {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Debug, $($v)*)
    }
}

/// Logs a message at the "trace" level.
#[macro_export]
macro_rules! trace {
    ($($v:tt)*) => {
        $crate::log!($crate::Level::Trace, $($v)*)
    }
}

/// Determines if a message logged at the specified level in the same module would be logged or not.
#[macro_export]
macro_rules! enabled {
    ($lvl:expr) => {{
        let level = $lvl;
        level <= $crate::max_level() && $crate::private::enabled(level, module_path!())
    }};
}