Struct Log

pub struct Log { /* private fields */ }

See module docs.

Implementations

impl Log

pub fn set_file_name<P: AsRef<Path>>(path: P)

Creates a new log file at the specified path.

pub fn set_file(file: Option<File>)

Sets new file to write the log to.

pub fn write<S>(kind: MessageKind, msg: S)

where S: AsRef<str>,

Writes a string to the console and optionally into the file (if set).

pub fn write_once<S>(id: usize, kind: MessageKind, msg: S) -> bool

where S: AsRef<str>,

Writes a string to the console and optionally into the file (if set). Unlike Self::write this method writes the message only once per given id if the message remains the same. If the message changes, then the new version will be printed to the log. This method is useful if you need to print error messages, but prevent them from flooding the log.

pub fn writeln<S>(kind: MessageKind, msg: S)

where S: AsRef<str>,

Writes a string to the console and optionally into the file (if set), adds a new line to the end of the message.

pub fn writeln_once<S>(id: usize, kind: MessageKind, msg: S) -> bool

where S: AsRef<str>,

Writes a string to the console and optionally into the file (if set), adds a new line to the end of the message. Prints the message only once. See Self::write_once for more info.

pub fn info<S>(msg: S)

where S: AsRef<str>,

Writes an information message.

pub fn warn<S>(msg: S)

where S: AsRef<str>,

Writes a warning message.

pub fn err<S>(msg: S)

where S: AsRef<str>,

Writes error message.

pub fn info_once<S>(id: usize, msg: S) -> bool

where S: AsRef<str>,

Writes an information message once. See Self::write_once for more info.

pub fn warn_once<S>(id: usize, msg: S) -> bool

where S: AsRef<str>,

Writes a warning message. See Self::write_once for more info.

pub fn err_once<S>(id: usize, msg: S) -> bool

where S: AsRef<str>,

Writes an error message once. See Self::write_once for more info.

pub fn set_verbosity(kind: MessageKind)

Sets verbosity level.

pub fn add_listener(listener: Sender<LogMessage>)

Adds a listener that will receive a copy of every message passed into the log.

pub fn verify<T, E>(result: Result<T, E>)

where E: Debug,

Allows you to verify that the result of the operation is Ok, or print the error in the log.

Use cases

Typical use case for this method is that when you can ignore errors, but want them to be in the log.

pub fn verify_message<S, T, E>(result: Result<T, E>, msg: S)

where E: Debug, S: Display,

Allows you to verify that the result of the operation is Ok, or print the error in the log.

Use cases

Typical use case for this method is that when you can ignore errors, but want them to be in the log.