Struct ExponentialDecayHistogram 

pub struct ExponentialDecayHistogram<T = ()> { /* private fields */ }

A histogram which exponentially weights in favor of recent values.

See the crate level documentation for more details.

Implementations

impl ExponentialDecayHistogram

pub fn new() -> Self

Returns a new histogram with a default configuration.

pub fn builder() -> Builder

Returns a new builder to create a histogram with a custom configuration.

pub fn with_size_and_alpha(size: usize, alpha: f64) -> Self

👎Deprecated: use ExponentialDecayHistogram::builder() instead

Returns a new histogram configured with the specified size and alpha.

size specifies the number of values stored in the histogram. A larger size will provide more accurate statistics, but with a higher memory overhead.

alpha specifies the exponential decay factor. A larger factor biases the histogram towards newer values.

Panics

Panics if size is zero.

pub fn update(&mut self, value: i64)

Inserts a value into the histogram at the current time.

pub fn update_at(&mut self, time: Instant, value: i64)

Inserts a value into the histogram at the specified time.

Panics

May panic if values are inserted at non-monotonically increasing times.

impl<T> ExponentialDecayHistogram<T>

where T: Clone,

pub fn update_ex(&mut self, value: i64, exemplar: T)

Like Self::update, except that it additionally takes an exemplar.

pub fn update_at_ex(&mut self, time: Instant, value: i64, exemplar: T)

Like Self::update_at, except that it additionally takes an exemplar.

pub fn snapshot(&self) -> Snapshot<T>

Takes a snapshot of the current state of the histogram.

Trait Implementations

impl<T: Debug> Debug for ExponentialDecayHistogram<T>

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

Formats the value using the given formatter.

impl Default for ExponentialDecayHistogram

fn default() -> ExponentialDecayHistogram

Returns the “default value” for a type.