Struct rust_utils::logging::Log

pub struct Log { /* private fields */ }

An automatic rotating log based on the current date

It logs output like the following

[hh:mm:ss] [LEVEL]: message

Implementations

impl Log

pub fn new(log_name: &str, folder: &str) -> Log

Creates a new log handle

Logs will be stored under $HOME/.local/share/<folder> and named <log_name>-<year>-<month>-<day>.log

Panics: You don’t seem to have a home folder. Make sure $HOME is set.

pub fn main_log(self, main_log: bool) -> Log

If this is true, there will be a main application log under /tmp/<folder name>-<username>/app.log

This log will be available for viewing until the system is rebooted

pub fn line<T: Display>(&self, level: LogLevel, text: T, print_stdout: bool)

Print a line to the log

This will print any object that implements Display

pub fn line_basic<T: Display>(&self, text: T, print_stdout: bool)

Print a line to the log (basic info)

pub fn report_panics(&self, report: bool)

Should this log handle be used to report application panics? This creates a panic handler that logs the thread panicked, where the panic occurred in the source and the backtrace.

This could be useful in conjunction with libraries that block stdout/stderr like cursive

pub fn main_log_path(&self) -> Option<PathBuf>

Returns the path of the main log for viewing

Returns None if the main log is not enabled

pub fn log_path(&self) -> PathBuf

Returns the path of the log file that is currently being written to

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.