Struct DebugLog 

pub struct DebugLog;

The global debug log.

Implementations

impl DebugLog

pub fn enabled() -> bool

Whether debug logging is on. Defaults to on in debug builds and off in release builds.

pub fn set_enabled(enabled: bool)

Turns debug logging on or off.

pub fn add_listener(listener: Arc<dyn IDebugListener>)

Adds a listener.

pub fn add_listener_function( action: impl Fn(&str, &str) + Send + Sync + 'static, ) -> u64

Adds a listener function. Closures can’t be compared, so use the returned handle with DebugLog::remove_listener_function to remove it.

pub fn remove_listener(listener: &Arc<dyn IDebugListener>)

Removes a listener (compared by identity).

pub fn remove_listener_function(id: u64)

Removes a listener function added with DebugLog::add_listener_function.

pub fn clear_listeners()

Removes all listeners.

pub fn subscribe() -> Receiver<DebugLogMessage>

Subscribes to debug log messages. A receiver that falls behind gets RecvError::Lagged and misses messages.

pub fn write_line(category: &str, msg: &str)

Writes a line to the debug log.

pub fn write_line_args(category: &str, msg: &str, args: &[&str])

Writes a line to the debug log, filling {0}, {1}, … in msg from args ({{ and }} are literal braces). Format specifiers like {0:X} aren’t supported and are left as they are.

pub fn assert(condition: bool, category: &str, message: &str)

If condition is false, writes message to the debug log.

Trait Implementations

impl Debug for DebugLog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.