Struct dipstick::Timer

pub struct Timer { /* fields omitted */ }

A timer that sends values to the metrics backend Timers can record time intervals in multiple ways :

• with the time! macrohich wraps an expression or block with start() and stop() calls.
• with the time(Fn) methodhich wraps a closure with start() and stop() calls.
• with start() and stop() methodsrapping around the operation to time
• with the interval_us() method, providing an externally determined microsecond interval

Methods

impl Timer

pub fn interval_us(&self, interval_us: u64) -> u64

Record a microsecond interval for this timer Can be used in place of start()/stop() if an external time interval source is used

pub fn start(&self) -> TimeHandle

Obtain a opaque handle to the current time. The handle is passed back to the stop() method to record a time interval. This is actually a convenience method to the TimeHandle::now() Beware, handles obtained here are not bound to this specific timer instance for now but might be in the future for safety. If you require safe multi-timer handles, get them through TimeType::now()

pub fn stop(&self, start_time: TimeHandle) -> MetricValue

Record the time elapsed since the start_time handle was obtained. This call can be performed multiple times using the same handle, reporting distinct time intervals each time. Returns the microsecond interval value that was recorded.

pub fn time<F: FnOnce() -> R, R>(&self, operations: F) -> R

Record the time taken to execute the provided closure

Methods from Deref<Target = InputMetric>

pub fn write(&self, value: MetricValue, labels: Labels)

Collect a new value for this metric.

pub fn metric_id(&self) -> &MetricId

Returns the unique identifier of this metric.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<InputMetric> for Timer

fn from(metric: InputMetric) -> Timer

Performs the conversion.

impl Debug for Timer

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

Formats the value using the given formatter.

impl Deref for Timer

type Target = InputMetric

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.