Struct RateComponents

#[non_exhaustive]
pub struct RateComponents {
    pub prev_samples: isize,
    pub curr_samples: isize,
    pub interval: Duration,
    pub current_interval_fraction: f64,
}

Input struct to custom functions for calculating rate. Includes the counts from the current interval, previous interval, the configured duration of an interval, and the fraction into the current interval that the sample was taken.

Ex. If the interval to the Rate instance is 10s, and the rate calculation is taken at 2 seconds after the start of the current interval, then the fraction of the current interval returned in this struct will be 0.2 meaning 20% of the current interval has elapsed

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

prev_samples: isize

curr_samples: isize

interval: Duration

current_interval_fraction: f64

Trait Implementations

impl Clone for RateComponents

fn clone(&self) -> RateComponents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateComponents

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

Formats the value using the given formatter.

impl PartialEq for RateComponents

fn eq(&self, other: &RateComponents) -> 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.

impl PartialOrd for RateComponents

fn partial_cmp(&self, other: &RateComponents) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RateComponents

impl StructuralPartialEq for RateComponents