Struct histogram::Snapshot

pub struct Snapshot { /* private fields */ }

A snapshot of a histogram across a time range.

Implementations

impl Snapshot

pub fn range(&self) -> Range<SystemTime>

Return the time range of the snapshot.

pub fn percentiles( &self, percentiles: &[f64] ) -> Result<Vec<(f64, Bucket)>, Error>

Return a collection of percentiles from this snapshot.

Each percentile should be in the inclusive range 0.0..=100.0. For example, the 50th percentile (median) can be found using 50.0.

The results will be sorted by the percentile.

pub fn percentile(&self, percentile: f64) -> Result<Bucket, Error>

Return a single percentile from this snapshot.

The percentile should be in the inclusive range 0.0..=100.0. For example, the 50th percentile (median) can be found using 50.0.

pub fn downsample(&self, factor: u8) -> Result<Snapshot, Error>

Returns a new downsampled histogram with a reduced grouping power.

The new histogram is smaller but with greater relative error. The reduction factor should be smaller than the histogram’s existing grouping power.

pub fn checked_merge(&self, rhs: &Self) -> Result<Self, Error>

Merges two snapshots which cover the same time range.

An error is raised on overflow.

pub fn checked_add(&self, rhs: &Self) -> Result<Self, Error>

Appends the provided snapshot onto this snapshot, extending the covered time range and combining the bucket counts.

An error is raised on overflow.

pub fn wrapping_add(&self, rhs: &Self) -> Result<Self, Error>

Appends the provided snapshot onto this snapshot, extending the covered time range and combining the bucket counts.

Bucket counters will wrap on overflow.

pub fn checked_sub(&self, rhs: &Self) -> Result<Self, Error>

Appends the provided snapshot onto this snapshot, shrinking the covered time range and producing a delta of the bucket counts.

An error is raised on overflow.

pub fn wrapping_sub(&self, rhs: &Self) -> Result<Self, Error>

Appends the provided snapshot onto this snapshot, extending the covered time range and combining the bucket counts.

Bucket counters will wrap on overflow.

pub fn config(&self) -> Config

Returns the bucket configuration of the snapshot.

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<&Snapshot> for SparseHistogram

fn from(snapshot: &Snapshot) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Snapshot

type Item = Bucket

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.