Struct diem_metrics::HistogramTimer

pub struct HistogramTimer { /* private fields */ }

Timer to measure and record the duration of an event.

This timer can be stopped and observed at most once, either automatically (when it goes out of scope) or manually. Alternatively, it can be manually stopped and discarded in order to not record its value.

Implementations

impl HistogramTimer

pub fn observe_duration(self)

Observe and record timer duration (in seconds).

It observes the floating-point number of seconds elapsed since the timer started, and it records that value to the attached histogram.

pub fn stop_and_record(self) -> f64

Observe, record and return timer duration (in seconds).

It observes and returns a floating-point number for seconds elapsed since the timer started, recording that value to the attached histogram.

pub fn stop_and_discard(self) -> f64

Observe and return timer duration (in seconds).

It returns a floating-point number of seconds elapsed since the timer started, without recording to any histogram.

Trait Implementations

impl Debug for HistogramTimer

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

Formats the value using the given formatter.

impl Drop for HistogramTimer

fn drop(&mut self)

Executes the destructor for this type.