rasant 0.6.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

//! Null log [sink][`sink::Sink`] module, intended mostly for testing.
//!
//! Black hole sinks are effectively no-op, but otherwise excercise every
//! aspect of Rasant.
use std::io;
use std::string;

use crate::attributes;
use crate::format;
use crate::sink;

/// Configuration struct for an [`BlackHole`] [sink][`sink::Sink`].
pub struct BlackHoleConfig {
	/// Output formatting configuration.
	pub formatter_cfg: format::FormatterConfig,
}

impl<'i> Default for BlackHoleConfig {
	fn default() -> Self {
		Self {
			formatter_cfg: format::FormatterConfig {
				format: format::OutputFormat::Compact,
				..format::FormatterConfig::default()
			},
		}
	}
}

/// A null log sink.
pub struct BlackHole {
	name: string::String,
	formatter: format::Formatter,
	out: io::Empty,
}

impl BlackHole {
	/// Initializes a new [`BlackHole`] log [sink][`sink::Sink`], from a given [`BlackHoleConfig`].
	pub fn new(conf: BlackHoleConfig) -> Self {
		Self {
			name: "black hole NULL logger".into(),
			formatter: format::Formatter::new(conf.formatter_cfg),
			out: io::empty(),
		}
	}
}

impl sink::Sink for BlackHole {
	fn name(&self) -> &str {
		self.name.as_str()
	}

	fn log(&mut self, update: &sink::LogUpdate, attrs: &attributes::Map) -> io::Result<()> {
		self.formatter.write(&mut self.out, update, attrs)?;
		self.formatter.write_delimiter(&mut self.out)
	}

	fn flush(&mut self) -> io::Result<()> {
		Ok(())
	}
}

/// Returns an intitalized [`BlackHole`] log [sink][`sink::Sink`], with default values.
pub fn default() -> BlackHole {
	BlackHole::new(BlackHoleConfig::default())
}