rasant 0.7.0

Rasant is a lightweight, high performance and flexible Rust library for structured logging.
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

use std::fmt;

use crate::attributes::Map;
use crate::attributes::scalar::Scalar;

/// Value definition for all log operations.
/// These are associated with a single [`&str`] key in attribute maps for [Logger][`crate::Logger`]s.
#[derive(Clone, Debug, PartialEq)]
pub enum Value<'e> {
	/// A single [`Scalar`] value.
	Scalar(Scalar),
	/// An ordered set of [`Scalar`] values.
	List(&'e [Scalar]),
	/// A map-like ordered set of { [`Scalar`] -> [`Scalar`] } value tuples.
	Map(&'e [Scalar], &'e [Scalar]),
}

/* ----------------------- Value implementation ----------------------- */

impl<'i> Value<'i> {
	/// Writes a string representation of a [`Value`] into an [`fmt::Write`].
	pub fn write_str<T: fmt::Write>(&self, out: &mut T, attrs: &Map) -> fmt::Result {
		match &self {
			Self::Scalar(s) => s.write_str(out, attrs),
			Self::List(ss) => {
				write!(out, "[")?;
				for i in 0..ss.len() {
					if i != 0 {
						write!(out, ", ")?;
					}
					ss[i].write_str(out, attrs)?;
				}
				write!(out, "]")
			}
			Self::Map(keys, ss) => {
				write!(out, "{{")?;
				for i in 0..keys.len() {
					if i != 0 {
						write!(out, ", ")?;
					}
					keys[i].write_str(out, attrs)?;
					write!(out, ": ")?;
					ss[i].write_str(out, attrs)?;
				}
				write!(out, "}}")
			}
		}
	}

	/// Serializes a [`Value`] into a pre-existing [`String`], whose contents are overwritten.
	pub fn into_string(&self, out: &mut String, attrs: &Map) {
		out.clear();
		self.write_str(out, attrs).expect("failed to serialize Value into_string()");
	}
}

/* ----------------------- Casting ----------------------- */

// casters for Value::Scalar
impl<'i, T: Into<Scalar>> From<T> for Value<'i> {
	fn from(t: T) -> Self {
		Self::Scalar(t.into())
	}
}

// casters for Value::List
impl<'i> From<&'i [Scalar]> for Value<'i> {
	fn from(s: &'i [Scalar]) -> Self {
		Self::List(s)
	}
}

/*
impl<'i, const N: usize> From<[Scalar; N]> for Value<'i> {
	fn from(a: [Scalar; N]) -> Self {
		Self::List(a.as_slice())
	}
}
*/

impl<'i, const N: usize> From<&'i [Scalar; N]> for Value<'i> {
	fn from(l: &'i [Scalar; N]) -> Self {
		Self::List(l.as_slice())
	}
}

/*
// casters for List of ToScalar's.
impl<'i, T: ToScalar, const N: usize> ToValue for [T; N] {
	fn to_value(&self) -> Value<'_> {
		Value::List(self.map(|x| x.to_scalar()).as_slice())
	}
}
*/

// casters for Value::Map
impl<'i> From<(&'i [Scalar], &'i [Scalar])> for Value<'i> {
	fn from(m: (&'i [Scalar], &'i [Scalar])) -> Self {
		Self::Map(m.0, m.1)
	}
}

/*
impl<'i, const N: usize> From<([Scalar; N], [Scalar; N])> for Value<'i> {
	fn from(m: ([Scalar; N], [Scalar; N])) -> Self {
		Self::Map(m.0.as_slice(), m.1.as_slice())
	}
}
*/

impl<'i, const N: usize> From<(&'i [Scalar; N], &'i [Scalar; N])> for Value<'i> {
	fn from(m: (&'i [Scalar; N], &'i [Scalar; N])) -> Self {
		Self::Map(m.0.as_slice(), m.1.as_slice())
	}
}

impl<'i> From<[&'i [Scalar]; 2]> for Value<'i> {
	fn from(m: [&'i [Scalar]; 2]) -> Self {
		Self::Map(m[0], m[1])
	}
}

/*
impl<'i, const N: usize> From<[[Scalar; N]; 2]> for Value<'i> {
	fn from(m: [[Scalar; N]; 2]) -> Self {
		Self::Map(m[0].as_slice(), m[1].as_slice())
	}
}
*/

impl<'i, const N: usize> From<[&'i [Scalar; N]; 2]> for Value<'i> {
	fn from(m: [&'i [Scalar; N]; 2]) -> Self {
		Self::Map(m[0].as_slice(), m[1].as_slice())
	}
}

impl<'i, const N: usize> From<&'i [&'i [Scalar; N]; 2]> for Value<'i> {
	fn from(m: &'i [&'i [Scalar; N]; 2]) -> Self {
		Self::Map(m[0].as_slice(), m[1].as_slice())
	}
}

/* ----------------------- Tests ----------------------- */

// TODO: add tests for Map
#[cfg(test)]
mod tests {
	use super::*;

	use crate::types::AttributeString;
	use ntime::{Duration, Timestamp};

	#[test]
	fn from_value_scalar() {
		let short_string = "lalala";
		let long_string = "this is a rather long string, which may be complicated";

		assert_eq!(Value::from(true), Value::Scalar(Scalar::Bool(true)));
		assert_eq!(Value::from(short_string), Value::Scalar(Scalar::String(AttributeString::from(short_string))));
		assert_eq!(
			Value::from(String::from(short_string)),
			Value::Scalar(Scalar::String(AttributeString::from(String::from(short_string))))
		);
		assert_eq!(Value::from(long_string), Value::Scalar(Scalar::String(AttributeString::from(long_string))));
		assert_eq!(Value::from(String::from(long_string)), Value::Scalar(Scalar::String(AttributeString::from(String::from(long_string)))));
		assert_eq!(Value::from(-12 as i8), Value::Scalar(Scalar::Int(-12)));
		assert_eq!(Value::from(345 as i16), Value::Scalar(Scalar::Int(345)));
		assert_eq!(Value::from(-678 as i32), Value::Scalar(Scalar::Int(-678)));
		assert_eq!(Value::from(9012 as i64), Value::Scalar(Scalar::Int(9012)));
		assert_eq!(Value::from(-3456 as i128), Value::Scalar(Scalar::LongInt(-3456)));
		assert_eq!(Value::from(7890 as isize), Value::Scalar(Scalar::Size(7890)));
		assert_eq!(Value::from(12 as u8), Value::Scalar(Scalar::Uint(12)));
		assert_eq!(Value::from(345 as u16), Value::Scalar(Scalar::Uint(345)));
		assert_eq!(Value::from(678 as u32), Value::Scalar(Scalar::Uint(678)));
		assert_eq!(Value::from(9012 as u64), Value::Scalar(Scalar::Uint(9012)));
		assert_eq!(Value::from(3456 as u128), Value::Scalar(Scalar::LongUint(3456)));
		assert_eq!(Value::from(7890 as usize), Value::Scalar(Scalar::Usize(7890)));
		// yaay precision!
		assert_eq!(Value::from(-123.456 as f32), Value::Scalar(Scalar::Float(-123.45600128173828)));
		assert_eq!(Value::from(789.012 as f64), Value::Scalar(Scalar::Float(789.012)));
		assert_eq!(Value::from(Duration::from_millis(12345)), Value::Scalar(Scalar::Uint(12)));
		assert_eq!(Value::from(&Duration::from_millis(67890)), Value::Scalar(Scalar::Uint(67)));
		assert_eq!(Value::from(Timestamp::from_millis(12345)), Value::Scalar(Scalar::Uint(12)));
		assert_eq!(Value::from(&Timestamp::from_millis(67890)), Value::Scalar(Scalar::Uint(67)));
	}

	// TODO: clean me up
	#[test]
	fn from_value_set() {
		let arr = [Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-12345678901234567)];
		let slice = &[Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-12345678901234567)];
		//assert_eq!(Value::from(arr), Value::List(&[Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-12345678901234567)]));
		assert_eq!(Value::from(&arr), Value::List(&[Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-12345678901234567)]));
		assert_eq!(Value::from(slice), Value::List(&[Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-12345678901234567)]));
	}

	// TODO: clean me up
	#[test]
	fn from_value_map() {
		let arrays = [
			&[Scalar::String("key_a".into()), Scalar::String("key_b".into()), Scalar::String("key_c".into())],
			&[Scalar::Bool(false), Scalar::Int(-123), Scalar::Float(456.789)],
		];
		let slices = &[&[Scalar::String("key_c".into()), Scalar::String("key_d".into())], &[Scalar::Bool(true), Scalar::Int(456)]];

		assert_eq!(
			//Value::from(arrays),
			Value::from(&arrays),
			Value::Map(
				&[Scalar::String("key_a".into()), Scalar::String("key_b".into()), Scalar::String("key_c".into())],
				&[Scalar::Bool(false), Scalar::Int(-123), Scalar::Float(456.789)]
			)
		);
		assert_eq!(
			Value::from(slices),
			Value::Map(&[Scalar::String("key_c".into()), Scalar::String("key_d".into())], &[Scalar::Bool(true), Scalar::Int(456)])
		);
	}

	#[test]
	fn into_string() {
		for tc in [
			(Value::Scalar(Scalar::Bool(true)), "true"),
			(Value::Scalar(Scalar::String("boo".into())), "\"boo\""),
			(Value::Scalar(Scalar::String(AttributeString::from("abcd 1234"))), "\"abcd 1234\""),
			(Value::Scalar(Scalar::Size(-12345678901234567)), "-0x2bdc545d6b4b87"),
			(Value::Scalar(Scalar::Uint(123456)), "123456"),
			(
				Value::List(&[
					Scalar::Bool(true),
					Scalar::String("boo".into()),
					Scalar::String("abcd 1234".into()),
					Scalar::Size(-12345678901234567),
					Scalar::Uint(123456),
				]),
				"[true, \"boo\", \"abcd 1234\", -0x2bdc545d6b4b87, 123456]",
			),
			(
				Value::Map(
					&[Scalar::Int(123), Scalar::Int(456), Scalar::Int(-789)],
					&[Scalar::Bool(true), Scalar::String("boo".into()), Scalar::Size(-111)],
				),
				"{123: true, 456: \"boo\", -789: -0x6f}",
			),
		] {
			let (v, want): (Value, &str) = tc;

			let mut out = String::from("lalalala!");
			let attrs = Map::new();

			v.into_string(&mut out, &attrs);
			assert_eq!(out, want);
		}
	}
}