label-logger 0.3.0

Cargo-like logging library
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

//! The replacement macro that uses core logger functions.

/// Prints a message with no or the provided label
///
/// ```
/// # use label_logger::log;
/// log!("Hello, world!");
/// ```
#[macro_export]
macro_rules! log {
	(label: $lbl:expr, $($arg:tt)+) => {
		$crate::println_label($lbl, std::format!($($arg)+))
	};
	($($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::default(), std::format!($($arg)*))
	};
}

/// Prints a message with the error label (prints to `stderr`)
///
/// ```
/// # use label_logger::error;
/// error!("An error occurred while deactivating the nuclear core");
/// // "Boom" will be displayed in red as a label
/// error!(label: "Boom", "it is too late");
/// ```
#[macro_export]
macro_rules! error {
	(label: $lbl:tt, $($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Error($lbl), std::format!($($arg)+))
	};
	($($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Error("Error"), std::format!($($arg)+))
	};
}

/// Prints a message with the warning label
///
/// ```
/// # use label_logger::warn;
/// warn!("This is fine, there are only 2849 warnings, but no errors");
/// // "Tic Tac" will be displayed in yellow as a label
/// warn!(label: "Tic Tac", "run forest, run!");
/// ```
#[macro_export]
macro_rules! warn {
	(label: $lbl:expr, $($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Warning($lbl), std::format!($($arg)+))
	};
	($($arg:tt)*) => {
		$crate::println_label($crate::OutputLabel::Warning("Warn"), std::format!($($arg)*))
	};
}

/// Prints a message with the info label and the provided text
///
/// ```
/// # use label_logger::info;
/// info!("Cleaning up the mess that was made");
/// // "Waiting" will be displayed in cyan (light blue) as a label
/// info!(label: "Waiting", "for OAuth2 callback");
/// ```
#[macro_export]
macro_rules! info {
	(label: $lbl:expr, $($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Info($lbl), std::format!($($arg)+))
	};
	($($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Info("Info"), std::format!($($arg)+))
	};
}

/// Prints a message with the success label and the provided text
///
/// ```
/// # use label_logger::success;
/// success!("temporary file successfully deleted");
/// // "Waouh" will be displayed in green as a label
/// success!(label: "Waouh", "you successfully did not went on StackOverflow for 5min");
/// ```
#[macro_export]
macro_rules! success {
	(label: $lbl:expr, $($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Success($lbl), std::format!($($arg)+))
	};
	($($arg:tt)+) => {
		$crate::println_label($crate::OutputLabel::Success("Success"), std::format!($($arg)+))
	};
}

/// Formats your message with the specified output label
///
/// ```
/// # use label_logger::{format_label, OutputLabel};
/// let _msg = format_label!(
///     label: OutputLabel::Info("Building"),
///     "one crate at a time"
/// );
/// ```
///
/// # Example
///
/// It can be useful when you need to have a correctly formatted message but you don't want to print it directly to the terminal.
///
// indicatif is only available on `indicatif` feature
/// ```ignore
/// use label_logger::{format_label, OutputLabel};
/// use indicatif::ProgressBar;
///
/// let mut bar = ProgressBar::new(100);
/// let msg = format_label!(
///    label: OutputLabel::Info("Building"),
///   "one crate at a time"
/// );
///
/// bar.set_message(msg);
/// ```
#[macro_export]
macro_rules! format_label {
	(label: $label:expr, $($arg:tt)+) => {
		$crate::pretty_output($label, std::format!($($arg)+))
	};
	($($arg:tt)+) => {
		$crate::pretty_output($crate::OutputLabel::default(), std::format!($($arg)+))
	};
}

#[cfg(test)]
mod tests {
	use crate::OutputLabel;

	#[test]
	fn log_macro_expand() {
		log!("Hello, world!");

		log!(label: OutputLabel::Error("Error"), "Hello");
	}

	#[test]
	fn error_macro_expand() {
		error!("Hello, error!");

		error!(label: "Bip Bip", "alert, everything is broken");
	}

	#[test]
	fn warn_macro_expand() {
		warn!("Hello, warn!");

		warn!(label: "Wow", "there is a bug here!");
	}

	#[test]
	fn info_macro_expand() {
		info!("Hello, info!");

		info!(label: "Ping", "new message");
	}

	#[test]
	fn success_macro_expand() {
		success!("Hello, success!");

		success!(label: "Nice", "you succeed!");
	}

	#[test]
	fn format_label_macro_expand() {
		format_label!(label: OutputLabel::Info("Hey"), "Hello, world!");
	}
}