easylog 2.0.1

A simple and easy to use logging-crate. Write log-messages to a file.
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

///
/// Struct to hold the configuration for the logfile
///
#[derive(Clone)]
pub struct LogFileConfig {
    /// maximum size for the logfile in MegaBytes - example: 1, 2, 3, 4, etc.
    pub max_size_in_mb: u64,

    /// Path to the file - example: "./", "~/logfolder/"
    pub path: String,

    /// filename - example: "logfile_", "my_log"
    pub name: String,

    /// fileextension - example: ".log", ".txt"
    pub extension: String,

    /// shall files be overwriten (starting from the first)
    /// when num_files_to_keep is reached.
    pub overwrite: bool,

    /// shall the file be truncated.
    pub truncate: bool,

    /// how many files shall be kept, if overwrite is true.
    /// If overwrite is false, this param has no effect.
    pub num_files_to_keep: u64,
}

impl LogFileConfig {
    /// Returns a LogFileConfig-struct with default parameters
    ///
    /// ## Default Params:
    /// - max_size_in_mb: 1
    /// - path: "./"
    /// - name: "logfile_"
    /// - extension: ".log"
    /// - overwrite: true
    /// - truncate: true
    /// - num_files_to_keep: 5
    ///
    pub fn new() -> LogFileConfig {
        LogFileConfig {
            max_size_in_mb: 1,
            path: String::from("./"),
            name: String::from("logfile_"),
            extension: String::from(".log"),
            overwrite: true,
            truncate: true,
            num_files_to_keep: 5,
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn default_constructor_test() {
        let default = LogFileConfig::new();

        assert_eq!(default.max_size_in_mb, 1);
        assert_eq!(default.path, "./");
        assert_eq!(default.name, "logfile_");
        assert_eq!(default.extension, ".log");
        assert_eq!(default.overwrite, true);
        assert_eq!(default.num_files_to_keep, 5);
    }
}