glore 0.1.4

Rust log
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

//! # glore at log
//!
//! **HowTo:**
//!
//! 1- Use `glore::GLORE` at the root of your project
//!
//! 2- Add a log target with `glore::init($target)` `$target` is anything that impl `Write`
//!
//! 3- log!
//!
//! *example of usage:*
//!
//! ```rust
//! use glore::{init, log, GLORE};
//! # fn main() {
//!
//!	let f = std::fs::OpenOptions::new()
//! 	.append(true)
//! 	.open("log.txt")
//! 	.unwrap();
//! let stdout = std::io::stdout();
//!
//! init(stdout);
//! log!("hello ====");
//! log!("world");
//!
//! init(f);
//! log!("hello ====");
//! std::thread::spawn(|| {
//! 	log!("world");
//! })
//! .join();
//! # }
//! ```
//!

use std::io::Write;
use std::sync::Mutex;
/// Use this static at the root of your project to enable logging
///
/// `use glore::GLORE;`
pub static mut GLORE: Option<Mutex<&mut dyn Write>> = None;

/// Use this function to add a log target
/// ```rust
///	let stdout = std::io::stdout();
///	glore::init(stdout);
/// ```
pub fn init(w: impl Write + 'static) {
    unsafe {
        let l = Box::new(w);
        let leaked = Box::leak(l);
        GLORE = Some(Mutex::new(leaked));
    }
}

#[macro_export]
/// Use this macro log any argrument
///
/// `log!("log one: {}", 1);`
macro_rules! log {
    ($($arg:tt)*) => (
    	std::sync::Once::new().call_once(||{
   		use crate::GLORE;

   	    unsafe {
   	    	if let Some(writer) = GLORE.as_mut() {
   	  			match writeln!(writer.lock().unwrap(), "{} line {}: {}", file!(), line!(), format_args!($($arg)*)) {
   	  				Ok(_) => (),
   	  				Err(e) => {panic!("Error writing to logger\nreason: {}", e);}
   	  			}
   	    	} else {
   	    		panic!("Nothing to log to yet, use init() before logging");
   	    	}
   	    }
   	    });
    );
}

#[cfg(test)]
mod tests {
    use super::{init, log};
    #[test]
    fn it_works() {
        let f = if let Ok(f) = std::fs::OpenOptions::new().append(true).open("log.txt") {
            f
        } else {
            std::fs::File::create("log.txt").unwrap()
        };

        let stdout = std::io::stdout();

        init(stdout);
        log!("hello ====");
        log!("world");

        init(f);
        log!("hello ====");
        let mut threads = vec![];

        for i in 0..10 {
            threads.push(std::thread::spawn(move || {
                log!("{}- world", i);
            }));
        }
        threads.into_iter().for_each(|t| t.join().unwrap());
    }
}