Struct RollingRateCounter

pub struct RollingRateCounter { /* private fields */ }

A rolling update counter. It records as many updates as the given sample rate and re-calculates the average update time on each call to update.

Generally, this is to be preferred over the discrete version. However, for very high values of sample, this can be quite inefficient, especially if the rate value isn’t needed during each cycle.

Usage

Call .update() every time your system starts a new update/cycle; for instance, an FPS counter would call this at the beginning of every frame. The sample rate (set with set_sample_rate() and in the first argument to new()) governs how many .update() calls are required before a meaningful result is produced.

You can also use .update_immut() for this to avoid a mutable binding.

Implementations

impl RollingRateCounter

pub fn new(samples: u64) -> Self

Create a new RollingRateCounter which calculates the update rate every update, averaging over a window of update_rate cycles.

Panics

This function will panic if given a value of samples equal to 0.

Trait Implementations

impl Clone for RollingRateCounter

fn clone(&self) -> RollingRateCounter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RollingRateCounter

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

Formats the value using the given formatter.

impl Display for RollingRateCounter

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

Formats the value using the given formatter.

impl RateCounter for RollingRateCounter

fn samples(&self) -> u64

Return the current number of samples the UpdateRateCounter is measuring.

fn set_samples(&mut self, samples: u64)

Set the number of updates which the UpdateRateCounter considers.

fn update(&mut self)

Updates the struct in place, but requires a mutable binding. Call either this OR update_immut() at the beginning of each cycle of the periodic activity being measured.

fn rate(&self) -> f64

Return the last calculated rate of operation, in Hertz (updates per second).