slog 0.3.0

Structured, composable logging 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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323

use serde;
use std::fmt::Write;
use serialize::hex::{ToHex};

/// Value that can be serialized
///
/// Loggers require values in key-value pairs to
/// implement this trait.
///
pub trait Serialize : Send+Sync+'static {
    /// Serialize self into `Serializer`
    ///
    /// Structs implementing this trait should generally
    /// only call respective methods of `serializer`.
    fn serialize(&self, key : &str, serializer : &mut Serializer);
}

/// Value that can be serialized and stored
/// in logger itself.
///
/// As Loggers itself must be thread-safe, they can only
/// store values implementing this trait.
pub trait SyncSerialize : Send+Sync+'static+Serialize {
}


/// Serializer
///
/// Drains using `Format` will internally use
/// types implementing this trait.
pub trait Serializer {
    /// Emit bool
    fn emit_bool(&mut self, key : &str, val : bool);
    /// Emit `()`
    fn emit_unit(&mut self, key : &str);
    /// Emit `None`
    fn emit_none(&mut self, key : &str);
    /// Emit `Some(val)`
    fn emit_some(&mut self, key : &str, val : &Serialize);
    /// Emit char
    fn emit_char(&mut self, key : &str, val : char);
    /// Emit bytes
    fn emit_bytes(&mut self, key : &str, val : &[u8]);
    /// Emit u8
    fn emit_u8(&mut self, key : &str, val : u8);
    /// Emit i8
    fn emit_i8(&mut self, key : &str, val : i8);
    /// Emit u16
    fn emit_u16(&mut self, key : &str, val : u16);
    /// Emit i16
    fn emit_i16(&mut self, key : &str, val : i16);
    /// Emit u32
    fn emit_u32(&mut self, key : &str, val : u32);
    /// Emit i32
    fn emit_i32(&mut self, key : &str, val : i32);
    /// Emit f32
    fn emit_f32(&mut self, key : &str, val : f32);
    /// Emit u64
    fn emit_u64(&mut self, key : &str, val : u64);
    /// Emit i64
    fn emit_i64(&mut self, key : &str, val : i64);
    /// Emit f64
    fn emit_f64(&mut self, key : &str, val : f64);
    /// Emit usize
    fn emit_usize(&mut self, key : &str, val : usize);
    /// Emit isize
    fn emit_isize(&mut self, key : &str, val : isize);
    /// Emit str
    fn emit_str(&mut self, key : &str, val : &str);
}

impl Serialize for str {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_str(key, self)
    }
}

impl Serialize for [u8] {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_bytes(key, self)
    }
}

impl Serialize for Box<[u8]> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_bytes(key, self)
    }
}

impl SyncSerialize for [u8] {}
impl SyncSerialize for Box<[u8]> {}

impl Serialize for Vec<u8> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_bytes(key, self.as_slice())
    }
}

impl Serialize for Box<Vec<u8>> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_bytes(key, self.as_slice())
    }
}

impl SyncSerialize for Vec<u8> {}

impl SyncSerialize for Box<Vec<u8>> {}

impl<T : Serialize> Serialize for Option<T> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        match *self {
            Some(ref s) => serializer.emit_some(key, s as &Serialize),
            None => serializer.emit_none(key),
        }
    }
}

impl<T : Serialize> Serialize for Box<Option<T>> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        (**self).serialize(key, serializer)
    }
}

impl<T : Serialize> SyncSerialize for Option<T> {}

impl<T : Serialize> SyncSerialize for Box<Option<T>> {}


impl Serialize for String {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_str(key, self.as_str())
    }
}

impl Serialize for Box<String> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        serializer.emit_str(key, self.as_str())
    }
}

impl SyncSerialize for Box<String> { }


macro_rules! impl_serialize_for{
    ($t:ty, $f:ident) => {
        impl Serialize for $t {
            fn serialize(&self, key : &str, serializer : &mut Serializer) {
                serializer.$f(key, *self)
            }
        }

        impl Serialize for Box<$t> where $t : Send+Sync {
            fn serialize(&self, key : &str, serializer : &mut Serializer) {
                serializer.$f(key, **self)
            }
        }

        impl SyncSerialize for Box<$t> where $t : Send+Sync { }


    };
}

impl_serialize_for!(&'static str, emit_str);
impl_serialize_for!(usize, emit_usize);
impl_serialize_for!(isize, emit_isize);
impl_serialize_for!(bool, emit_bool);
impl_serialize_for!(char, emit_char);
impl_serialize_for!(u8, emit_u8);
impl_serialize_for!(i8, emit_i8);
impl_serialize_for!(u16, emit_u16);
impl_serialize_for!(i16, emit_i16);
impl_serialize_for!(u32, emit_u32);
impl_serialize_for!(i32, emit_i32);
impl_serialize_for!(f32, emit_f32);
impl_serialize_for!(u64, emit_u64);
impl_serialize_for!(i64, emit_i64);
impl_serialize_for!(f64, emit_f64);

impl<S : Serialize, F : 'static+Sync+Send+Fn()->S> Serialize for Box<F> {
    fn serialize(&self, key : &str, serializer : &mut Serializer) {
        (*self)().serialize(key, serializer)
    }
}

impl<S : Serialize, F : 'static+Sync+Send+Fn()->S> SyncSerialize for Box<F> { }


/// Newtype to wrap serde Serializer, so that `Serialize` can be implemented
/// for it
pub struct SerdeSerializer<'a, S: 'a+serde::Serializer>(pub &'a mut S);

impl<'a, S> Serializer for SerdeSerializer<'a, S> where S : 'a+serde::Serializer {

    fn emit_bool(&mut self, key : &str, val : bool) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }

    fn emit_unit(&mut self, key : &str) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, ());
    }

    fn emit_char(&mut self, key : &str, val : char) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }

    fn emit_bytes(&mut self, key : &str, val : &[u8]) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }

    fn emit_none(&mut self, key : &str) {
        let none : Option<()> = None;
        let _ = serde::Serializer::serialize_map_elt(self.0, key, none);
    }

    fn emit_some(&mut self, key : &str, val : &Serialize) {
        val.serialize(key, self)
    }

    fn emit_u8(&mut self, key : &str, val : u8) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_i8(&mut self, key : &str, val : i8) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_u16(&mut self, key : &str, val : u16) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_i16(&mut self, key : &str, val : i16) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_usize(&mut self, key : &str, val : usize) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_isize(&mut self, key : &str, val : isize) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_u32(&mut self, key : &str, val : u32) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_i32(&mut self, key : &str, val : i32) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_f32(&mut self, key : &str, val : f32) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_u64(&mut self, key : &str, val : u64) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_i64(&mut self, key : &str, val : i64) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_f64(&mut self, key : &str, val : f64) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
    fn emit_str(&mut self, key : &str, val : &str) {
        let _ = serde::Serializer::serialize_map_elt(self.0, key, val);
    }
}

impl Serializer for String {
    fn emit_none(&mut self, key : &str) {
        write!(self, "{}: {}", key, "None").unwrap()
    }
    fn emit_unit(&mut self, key : &str) {
        write!(self, "{}: ()", key, ).unwrap()
    }

    fn emit_bool(&mut self, key : &str, val : bool) {
        write!(self, "{}: {}", key, val).unwrap()
    }

    fn emit_char(&mut self, key : &str, val : char) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_bytes(&mut self, key : &str, val : &[u8]) {
        write!(self, "{}: {}", key, val.to_hex()).unwrap()
    }
    fn emit_some(&mut self, key : &str, val : &Serialize) {
        val.serialize(key, self);
    }

    fn emit_usize(&mut self, key : &str, val : usize) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_isize(&mut self, key : &str, val : isize) {
        write!(self, "{}: {}", key, val).unwrap()
    }

    fn emit_u8(&mut self, key : &str, val : u8) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_i8(&mut self, key : &str, val : i8) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_u16(&mut self, key : &str, val : u16) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_i16(&mut self, key : &str, val : i16) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_u32(&mut self, key : &str, val : u32) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_i32(&mut self, key : &str, val : i32) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_f32(&mut self, key : &str, val : f32) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_u64(&mut self, key : &str, val : u64) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_i64(&mut self, key : &str, val : i64) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_f64(&mut self, key : &str, val : f64) {
        write!(self, "{}: {}", key, val).unwrap()
    }
    fn emit_str(&mut self, key : &str, val : &str) {
        write!(self, "{}: {}", key, val).unwrap()
    }
}