cat-loggr 1.0.2

A simple, lightweight utility for making beautiful logs
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

use std::fmt;

use chrono::{DateTime, Utc};

/// Arguments passed to a [`PostHookCallback`]
#[derive(Debug)]
pub struct PostHookCallbackParams {
	/// The level of the log
	pub level: String,
	/// The final formatted text
	pub text: String,
	/// The timestamp of execution
	pub date: DateTime<Utc>,
	/// The formatted timestamp
	pub timestamp: String,
	/// The shard ID
	pub shard: Option<String>,
	// context:
}

/// Arguments passed to a [`PreHookCallback`]
pub struct PreHookCallbackParams<'a> {
	/// The level of the log
	pub level: String,
	/// The arguments being logged
	pub args: fmt::Arguments<'a>,
	/// The timestamp of execution
	pub date: DateTime<Utc>,
	/// The formatted timestamp
	pub timestamp: String,
	/// The shard ID
	pub shard: Option<String>,
}

/// An argument hook callback function
///
/// # Arguments
/// * `args` - The provided argument
/// * `date` - The timestamp of execution
pub type ArgHookCallback = fn(args: Option<fmt::Arguments>, date: DateTime<Utc>) -> Option<String>;

/// A post hook callback function
///
/// # Arguments
/// * `params` - The parameters that are sent by the hook
pub type PostHookCallback = fn(params: PostHookCallbackParams) -> Option<String>;

/// A pre hook callback function
///
/// # Arguments
/// * `params` - The parameters that are sent by the hook
pub type PreHookCallback = fn(params: PreHookCallbackParams) -> Option<String>;

#[derive(Default)]
pub struct LogHooks {
	pub pre: Vec<PreHookCallback>,
	pub arg: Vec<ArgHookCallback>,
	pub post: Vec<PostHookCallback>,
}

impl LogHooks {
	pub fn new() -> Self {
		Self {
			pre: Vec::<PreHookCallback>::new(),
			arg: Vec::<ArgHookCallback>::new(),
			post: Vec::<PostHookCallback>::new(),
		}
	}
}