Struct LockFreeHistogram

pub struct LockFreeHistogram<const N: usize> { /* private fields */ }

A LockFreeHistogram. This trades the ability to resize to accomodate new observations as Histogram does in exchange for providing a concurrent, lock-free histogram.

Implementations

impl<const N: usize> LockFreeHistogram<N>

pub const fn new(sig_figs: i32) -> Self

Create a new lock-free histogram with the specified number of sig_figs.

Panics

Under the same conditions as SigFigBucketizer::new.

pub fn sig_figs(&self) -> i32

Return the nubmer of significant figures in use for this histogram.

pub fn observe(&self, x: f64) -> Result<(), Error>

Observe a value x and increment the bucket for x.

This will fail with Error::ExceedsMax if the bucket exceeds template parameter N.

pub fn observe_n(&self, x: f64, n: u64) -> Result<(), Error>

Observe a value x and increment its bucket n times.

This will fail with Error::ExceedsMax if the bucket exceeds template parameter N.

pub fn iter(&self) -> impl Iterator<Item = u64> + '_

Return an iterator over this bucket.

pub fn to_histogram(&self) -> Histogram

Create a Histogram from this histogram.