Struct hdrhistogram::iterators::IterationValue

pub struct IterationValue<T: Counter> { /* fields omitted */ }

The value emitted at each step when iterating over a Histogram.

Methods

impl<T: Counter> IterationValue<T>

pub fn new(
    value_iterated_to: u64,
    quantile: f64,
    quantile_iterated_to: f64,
    count_at_value: T,
    count_since_last_iteration: u64
) -> IterationValue<T>

Create a new IterationValue.

pub fn value_iterated_to(&self) -> u64

The value iterated to. Some iterators provide a specific value inside the bucket, while others just use the highest value in the bucket.

pub fn percentile(&self) -> f64

Percent of recorded values that are at or below the current bucket. This is simply the quantile multiplied by 100.0, so if you care about maintaining the best floating-point precision, use quantile() instead.

pub fn quantile(&self) -> f64

Quantile of recorded values that are at or below the current bucket.

pub fn quantile_iterated_to(&self) -> f64

Quantile iterated to, which may be different than quantile() when an iterator provides information about the specific quantile it's iterating to.

pub fn count_at_value(&self) -> T

Recorded count for values equivalent to value

pub fn count_since_last_iteration(&self) -> u64

Number of values traversed since the last iteration step

Trait Implementations

impl<T: PartialEq + Counter> PartialEq<IterationValue<T>> for IterationValue<T>

fn eq(&self, other: &IterationValue<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IterationValue<T>) -> bool

This method tests for !=.

impl<T: Debug + Counter> Debug for IterationValue<T>

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

Formats the value using the given formatter.