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

//! Generic file logging log [sink][`crate::sink::Sink`] module.
//!
//! Built around [`IO`], so it inherits pretty much all of
//! its configuration options.
use std::fs;
use std::io::Write;
use std::path::PathBuf;

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

/// Configuration struct for a file [`IO`] log sink.
pub struct FileConfig {
	/// Name for this sink.
	pub name: String,
	/// Output formatting configuration.
	pub formatter_cfg: format::FormatterConfig,
	/// String delimiter, inserted between log writes.
	pub delimiter: String,
	/// Whether file writes are buffered or not.
	pub buffered: bool,
	/// Whether to flush immediately after every write operation.
	pub flush_on_write: bool,
	/// Wheter to append on existing file paths, or truncate them.
	pub append: bool,
	/// Full file path to write to, as a [`std::path::PathBuf`].
	pub path: Option<PathBuf>,
}

impl Default for FileConfig {
	fn default() -> Self {
		Self {
			name: "file".into(),
			formatter_cfg: format::FormatterConfig::default(),
			delimiter: "\n".into(),
			buffered: true,
			flush_on_write: false,
			append: true,
			path: None,
		}
	}
}

/// Initializes a file log [sink][`crate::sink::Sink`] from a [`FileConfig`].
pub fn new<'f>(conf: FileConfig) -> IO<'f> {
	let Some(path) = conf.path else {
		panic!("missing path for logfile sink");
	};

	let exists = match fs::exists(&path) {
		Ok(b) => b,
		Err(e) => panic!("failed to check if log file for \"{name}\" at {path} exists: {e}", name = &conf.name, path = path.display()),
	};
	let mut fh = match fs::File::options().create(true).write(true).append(conf.append).truncate(!conf.append).open(&path) {
		Ok(fh) => fh,
		Err(e) => {
			panic!("failed to open log file for \"{name}\" at {path}: {e:?}", name = &conf.name, path = path.display());
		}
	};
	if exists {
		match fh.write(conf.delimiter.as_bytes()) {
			Ok(_) => (),
			Err(e) => panic!("failed to insert append delimiter for \"{name}\" at {path}: {e}", name = &conf.name, path = path.display()),
		};
	}

	IO::new(IOConfig {
		name: conf.name,
		formatter_cfg: conf.formatter_cfg,
		delimiter: conf.delimiter,
		buffered: conf.buffered,
		flush_on_write: conf.flush_on_write,
		out: Some(fh),
	})
}