Struct RealtimeLogger 

pub struct RealtimeLogger { /* private fields */ }

A helper used for realtime-safe logging on the audio thread.

Implementations

impl RealtimeLogger

pub fn max_message_length(&self) -> usize

The allocated capacity for each message slot.

pub fn available_debug_slots(&self) -> usize

Returns the number of slots that are available for debug messages.

This will always return 0 when compiled without debug assertions.

pub fn available_error_slots(&self) -> usize

Returns the number of slots that are available for error messages.

pub fn try_debug(&mut self, message: &str) -> Result<(), RealtimeLogError>

Log the given debug message.

NOTE, avoid using this method in the final release of your node. This is only meant for debugging purposes while developing.

This will do nothing when compiled without debug assertions.

pub fn try_debug_with( &mut self, f: impl FnOnce(&mut String), ) -> Result<(), RealtimeLogError>

Log a debug message into the given string.

This string is gauranteed to be empty and have an allocated capacity of at least RealtimeLogger::max_message_length.

NOTE, avoid using this method in the final release of your node. This is only meant for debugging purposes while developing.

This will do nothing when compiled without debug assertions.

pub fn try_error(&mut self, message: &str) -> Result<(), RealtimeLogError>

Log the given error message.

pub fn try_error_with( &mut self, f: impl FnOnce(&mut String), ) -> Result<(), RealtimeLogError>

Log an error message into the given string.

This string is gauranteed to be empty and have an allocated capacity of at least RealtimeLogger::max_message_length.