Struct datafusion_physical_plan::metrics::Time

pub struct Time { /* private fields */ }

Measure a potentially non contiguous duration of time

Implementations

impl Time

pub fn new() -> Self

Create a new Time wrapper suitable for recording elapsed times for operations.

pub fn add_elapsed(&self, start: Instant)

Add elapsed nanoseconds since startto self

pub fn add_duration(&self, duration: Duration)

Add duration of time to self

Note: this will always increment the recorded time by at least 1 nanosecond to distinguish between the scenario of no values recorded, in which case the value will be 0, and no measurable amount of time having passed, in which case the value will be small but not 0.

This is based on the assumption that the timing logic in most cases is likely to take at least a nanosecond, and so this is reasonable mechanism to avoid ambiguity, especially on systems with low-resolution monotonic clocks

pub fn add(&self, other: &Time)

Add the number of nanoseconds of other Time to self

pub fn timer(&self) -> ScopedTimerGuard<'_>

return a scoped guard that adds the amount of time elapsed between its creation and its drop or call to stop to the underlying metric.

pub fn value(&self) -> usize

Get the number of nanoseconds record by this Time metric

Trait Implementations

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Self

Returns the “default value” for a type.

impl Display for Time

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

Formats the value using the given formatter.

impl PartialEq for Time

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.