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

//! A [stdout](https://en.wikipedia.org/wiki/Standard_streams) [sink][`crate::sink::Sink`] module.
use std::io;

use crate::format;
use crate::sink::io::{IO, IOConfig};

/// Configuration struct for an `stdout` [sink][`crate::sink::Sink`].
pub struct StdoutConfig {
	/// Name for this sink.
	pub name: String,
	/// Output formatting configuration.
	pub formatter_cfg: format::FormatterConfig,
	/// Whether writes to `stdout` are buffered or not.
	pub buffered: bool,
	/// Whether to flush immediately after every `stdout` write.
	pub flush_on_write: bool,
}

impl Default for StdoutConfig {
	fn default() -> Self {
		Self {
			name: String::from("STDOUT"),
			formatter_cfg: format::FormatterConfig {
				format: format::OutputFormat::ColorCompact,
				..format::FormatterConfig::default()
			},
			buffered: true,
			flush_on_write: false,
		}
	}
}

/// Initializes a `stdout` [sink][`crate::sink::Sink`] from a [`StdoutConfig`].
pub fn new<'f>(conf: StdoutConfig) -> IO<'f> {
	IO::new(IOConfig {
		name: conf.name,
		formatter_cfg: conf.formatter_cfg,
		buffered: conf.buffered,
		flush_on_write: conf.flush_on_write,
		out: Some(io::stdout()),
		..IOConfig::default()
	})
}

/// Returns an initialized `IO` [sink][`crate::sink::Sink`] for `stdout`, with default values.
pub fn default<'f>() -> IO<'f> {
	new(StdoutConfig::default())
}