log 0.4.10

A lightweight logging facade 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

use std::fmt;

use super::{Error, Fill, Slot};
use kv;

// `Visitor` is an internal API for visiting the structure of a value.
// It's not intended to be public (at this stage).

/// A container for a structured value for a specific kind of visitor.
#[derive(Clone, Copy)]
pub(super) enum Inner<'v> {
    /// A simple primitive value that can be copied without allocating.
    Primitive(Primitive<'v>),
    /// A value that can be filled.
    Fill(&'v dyn Fill),
    /// A debuggable value.
    Debug(&'v dyn fmt::Debug),
    /// A displayable value.
    Display(&'v dyn fmt::Display),

    #[cfg(feature = "kv_unstable_sval")]
    /// A structured value from `sval`.
    Sval(&'v dyn sval_support::Value),
}

impl<'v> Inner<'v> {
    pub(super) fn visit(&self, visitor: &mut dyn Visitor) -> Result<(), Error> {
        match *self {
            Inner::Primitive(value) => match value {
                Primitive::Signed(value) => visitor.i64(value),
                Primitive::Unsigned(value) => visitor.u64(value),
                Primitive::Float(value) => visitor.f64(value),
                Primitive::Bool(value) => visitor.bool(value),
                Primitive::Char(value) => visitor.char(value),
                Primitive::Str(value) => visitor.str(value),
                Primitive::None => visitor.none(),
            },
            Inner::Fill(value) => value.fill(&mut Slot::new(visitor)),
            Inner::Debug(value) => visitor.debug(value),
            Inner::Display(value) => visitor.display(value),

            #[cfg(feature = "kv_unstable_sval")]
            Inner::Sval(value) => visitor.sval(value),
        }
    }
}

/// The internal serialization contract.
pub(super) trait Visitor {
    fn debug(&mut self, v: &dyn fmt::Debug) -> Result<(), Error>;
    fn display(&mut self, v: &dyn fmt::Display) -> Result<(), Error> {
        self.debug(&format_args!("{}", v))
    }

    fn u64(&mut self, v: u64) -> Result<(), Error>;
    fn i64(&mut self, v: i64) -> Result<(), Error>;
    fn f64(&mut self, v: f64) -> Result<(), Error>;
    fn bool(&mut self, v: bool) -> Result<(), Error>;
    fn char(&mut self, v: char) -> Result<(), Error>;
    fn str(&mut self, v: &str) -> Result<(), Error>;
    fn none(&mut self) -> Result<(), Error>;

    #[cfg(feature = "kv_unstable_sval")]
    fn sval(&mut self, v: &dyn sval_support::Value) -> Result<(), Error>;
}

#[derive(Clone, Copy)]
pub(super) enum Primitive<'v> {
    Signed(i64),
    Unsigned(u64),
    Float(f64),
    Bool(bool),
    Char(char),
    Str(&'v str),
    None,
}

mod fmt_support {
    use super::*;

    impl<'v> kv::Value<'v> {
        /// Get a value from a debuggable type.
        pub fn from_debug<T>(value: &'v T) -> Self
        where
            T: fmt::Debug,
        {
            kv::Value {
                inner: Inner::Debug(value),
            }
        }

        /// Get a value from a displayable type.
        pub fn from_display<T>(value: &'v T) -> Self
        where
            T: fmt::Display,
        {
            kv::Value {
                inner: Inner::Display(value),
            }
        }
    }

    impl<'v> fmt::Debug for kv::Value<'v> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            self.visit(&mut FmtVisitor(f))?;

            Ok(())
        }
    }

    impl<'v> fmt::Display for kv::Value<'v> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            self.visit(&mut FmtVisitor(f))?;

            Ok(())
        }
    }

    struct FmtVisitor<'a, 'b: 'a>(&'a mut fmt::Formatter<'b>);

    impl<'a, 'b: 'a> Visitor for FmtVisitor<'a, 'b> {
        fn debug(&mut self, v: &dyn fmt::Debug) -> Result<(), Error> {
            v.fmt(self.0)?;

            Ok(())
        }

        fn u64(&mut self, v: u64) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn i64(&mut self, v: i64) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn f64(&mut self, v: f64) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn bool(&mut self, v: bool) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn char(&mut self, v: char) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn str(&mut self, v: &str) -> Result<(), Error> {
            self.debug(&format_args!("{:?}", v))
        }

        fn none(&mut self) -> Result<(), Error> {
            self.debug(&format_args!("None"))
        }

        #[cfg(feature = "kv_unstable_sval")]
        fn sval(&mut self, v: &dyn sval_support::Value) -> Result<(), Error> {
            sval_support::fmt(self.0, v)
        }
    }
}

#[cfg(feature = "kv_unstable_sval")]
pub(super) mod sval_support {
    use super::*;

    extern crate sval;

    impl<'v> kv::Value<'v> {
        /// Get a value from a structured type.
        pub fn from_sval<T>(value: &'v T) -> Self
        where
            T: sval::Value,
        {
            kv::Value {
                inner: Inner::Sval(value),
            }
        }
    }

    impl<'v> sval::Value for kv::Value<'v> {
        fn stream(&self, s: &mut sval::value::Stream) -> sval::value::Result {
            self.visit(&mut SvalVisitor(s)).map_err(Error::into_sval)?;

            Ok(())
        }
    }

    pub(in kv::value) use self::sval::Value;

    pub(super) fn fmt(f: &mut fmt::Formatter, v: &dyn sval::Value) -> Result<(), Error> {
        sval::fmt::debug(f, v)?;
        Ok(())
    }

    impl Error {
        fn from_sval(_: sval::value::Error) -> Self {
            Error::msg("`sval` serialization failed")
        }

        fn into_sval(self) -> sval::value::Error {
            sval::value::Error::msg("`sval` serialization failed")
        }
    }

    struct SvalVisitor<'a, 'b: 'a>(&'a mut sval::value::Stream<'b>);

    impl<'a, 'b: 'a> Visitor for SvalVisitor<'a, 'b> {
        fn debug(&mut self, v: &dyn fmt::Debug) -> Result<(), Error> {
            self.0
                .fmt(format_args!("{:?}", v))
                .map_err(Error::from_sval)
        }

        fn u64(&mut self, v: u64) -> Result<(), Error> {
            self.0.u64(v).map_err(Error::from_sval)
        }

        fn i64(&mut self, v: i64) -> Result<(), Error> {
            self.0.i64(v).map_err(Error::from_sval)
        }

        fn f64(&mut self, v: f64) -> Result<(), Error> {
            self.0.f64(v).map_err(Error::from_sval)
        }

        fn bool(&mut self, v: bool) -> Result<(), Error> {
            self.0.bool(v).map_err(Error::from_sval)
        }

        fn char(&mut self, v: char) -> Result<(), Error> {
            self.0.char(v).map_err(Error::from_sval)
        }

        fn str(&mut self, v: &str) -> Result<(), Error> {
            self.0.str(v).map_err(Error::from_sval)
        }

        fn none(&mut self) -> Result<(), Error> {
            self.0.none().map_err(Error::from_sval)
        }

        fn sval(&mut self, v: &dyn sval::Value) -> Result<(), Error> {
            self.0.any(v).map_err(Error::from_sval)
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use kv::value::test::Token;

        #[test]
        fn test_from_sval() {
            assert_eq!(kv::Value::from_sval(&42u64).to_token(), Token::Sval);
        }

        #[test]
        fn test_sval_structured() {
            let value = kv::Value::from(42u64);
            let expected = vec![sval::test::Token::Unsigned(42)];

            assert_eq!(sval::test::tokens(value), expected);
        }
    }
}