Struct Builder

pub struct Builder { /* private fields */ }

A builder type for ExponentialDecayHistogram objects.

Implementations

impl Builder

pub fn at(&mut self, now: Instant) -> &mut Self

Sets the construction time of the histogram.

Defaults to the system time when the Builder was constructed.

pub fn size(&mut self, size: usize) -> &mut Self

Sets the size of the histogram.

A larger size will provide a more accurate histogram, but with a higher memory overhead.

Defaults to 1028, which offers a 99.9% confidence level with a 5% margin of error.

Panics

Panics if size is 0.

pub fn alpha(&mut self, alpha: f64) -> &mut Self

Sets the decay rate of the histogram.

A larger value biases the histogram towards newer values.

Defaults to 0.015, which heavily biases towards the last 5 minutes of values.

pub fn build(&self) -> ExponentialDecayHistogram

Creates a new ExponentialDecayHistogram.