Struct aleo_std_timer::Timer

pub struct Timer<'name> { /* private fields */ }

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.

Implementations

impl<'name> Timer<'name>

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

Constructs a new Timer that prints a ‘Start’ and a ‘Finish’ message. This method is not usually called directly, use the timer! macro instead.

pub fn elapsed(&self, elapsed: Duration) -> String

Returns how long the timer has been running for.

pub fn elapsed_colored(&self, elapsed: Duration) -> ColoredString

Returns how long the timer has been running for.

pub fn lap(&self, args: Option<Arguments<'_>>)

Outputs a log message with a target of ‘Lap’ 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 lap! macro.

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

Outputs a log message with a target of ‘Finish’ 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 Timer<'a>

fn drop(&mut self)

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