Struct dipstick::Timer

pub struct Timer<C: MetricSink + 'static> { /* fields omitted */ }

A timer that sends values to the metrics backend Timers can record time intervals in multiple ways : - with the time! macro, which wraps an expression or block with start() and stop() calls. - with the time(Fn) method, which wraps a closure with start() and stop() calls. - with start() and stop() methods, wrapping around the operation to time - with the interval_us() method, providing an externally determined microsecond interval

Methods

impl<C: MetricSink> Timer<C>

fn interval_us<V>(&self, interval_us: V) -> V where
    V: ToPrimitive, 

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

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()

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

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.

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

Record the time taken to execute the provided closure

Trait Implementations

impl<C: Debug + MetricSink + 'static> Debug for Timer<C>

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

Formats the value using the given formatter.