Struct logging_timer::LoggingTimer

pub struct LoggingTimer<'name> { /* fields omitted */ }

When this struct is dropped, it logs a message stating its name and how long the execution time was. Can be used to time functions or other critical areas.

Methods

impl<'name> LoggingTimer<'name>

pub fn new(
    file: &'static str,
    module_path: &'static str,
    line: u32,
    name: &'name str,
    extra_info: Option<String>
) -> Self

Constructs a new LoggingTimer that prints only a 'TimerFinished' message. This method is not usually called directly, use the timer! macro instead.

pub fn with_start_message(
    file: &'static str,
    module_path: &'static str,
    line: u32,
    name: &'name str,
    extra_info: Option<String>
) -> Self

Constructs a new LoggingTimer that prints a 'TimerStarting' and a 'TimerFinished' message. This method is not usually called directly, use the stimer! macro instead.

pub fn elapsed(&self) -> Duration

Returns how long the timer has been running for.

pub fn level(self, level: Level) -> Self

Sets the logging level. Note that this consumes self, so that it can be called in a one-liner like this:

let tmr = timer!("foo").level(Level::Trace);

pub fn executing(&self, args: Option<Arguments>)

Outputs a log message with a target of 'TimerExecuting' showing the current elapsed time, but does not stop the timer. This method can be called multiple times. The message can include further information via a format_args! approach. This method is usually not called directly, it is easier to use the executing! macro.

pub fn finish(&self, args: Option<Arguments>)

Outputs a log message with a target of 'TimerFinished' and suppresses the normal message that is output when the timer is dropped. The message can include further format_args! information. This method is normally called using the finish! macro. Calling finish() again will have no effect.

Trait Implementations

impl<'a> Drop for LoggingTimer<'a>

fn drop(&mut self)

Drops the timer, outputting a log message with a target of TimerFinished if the finish method has not yet been called.