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

//! Log sinks for use with Rasant [`crate::Logger`] instances.
//!
//! This module defines the [`Sink`] and [`LogUpdate`] traits for sinks, and
//! exports all available sink types.
pub mod black_hole;
pub mod file;
pub mod io;
pub mod log_file;
pub mod stderr;
pub mod stdout;
pub mod string;

use ntime;
use std::io as std_io;

use crate::attributes;
use crate::level;

/// Depth for a [`crate::logger::Logger`] - i.e. how many parent instances it has.
pub type LogDepth = u16;
/// Maximum allowed [`crate::logger::Logger`] depth.
pub const MAX_LOGDEPTH: u16 = 1024;

/// Encapsulates a single log update, without attributes.
#[derive(Clone, Debug)]
pub struct LogUpdate {
	/// [Timestamp][`ntime::Timestamp`] for the log update.
	pub when: ntime::Timestamp,
	/// [Level][`level::Level`] for the log update.
	pub level: level::Level,
	// TODO: use me for fancy hierarchic log output
	//depth: LogDepth,
	/// Message for the log update.
	pub msg: String,
}

impl LogUpdate {
	/// Initializes a [`LogUpdate`] for a given timestamp, log level and log meessage.
	pub fn new(now: ntime::Timestamp, level: level::Level, msg: String) -> Self {
		Self {
			when: now,
			level: level,
			//depth: depth,
			msg: msg,
		}
	}
}

/// Defines a log sink usable by [Logger][`crate::logger::Logger`]s.
pub trait Sink {
	/// Returns a [`&str`] name for the sink.
	fn name(&self) -> &str;
	/// Write a [`LogUpdate`] to this sink, with associated attributes.
	fn log(&mut self, update: &LogUpdate, attrs: &attributes::Map) -> std_io::Result<()>;
	/// Flushes any pending writes for the sink.
	fn flush(&mut self) -> std_io::Result<()>;

	/// Whether this sink should receive all levels, instead of pre-filtering by the [`level::Level`] associated with a [`crate::logger::Logger`].
	fn receives_all_levels(&self) -> bool {
		false
	}
}