Struct metrics_util::Quantile

pub struct Quantile(_, _);

A quantile that has both the raw value and a human-friendly display label.

We work with quantiles for optimal floating-point precison over percentiles, but most of the time, monitoring systems show us percentiles, and usually in an abbreviated form: p99.

On top of holding the quantile value, we calculate the familiar "p99" style of label, doing the appropriate percentile conversion. Thus, if you have a quantile of 0.99, the resulting label is p99, and if you have a quantile of 0.999, the resulting label is p999.

There are two special cases, where we label 0.0 and 1.0 as min and max, respectively.

Methods

impl Quantile

pub fn new(quantile: f64) -> Quantile

Creates a new Quantile from a floating-point value.

All values are clamped between 0.0 and 1.0.

pub fn label(&self) -> &str

Gets the human-friendly display label.

pub fn value(&self) -> f64

Gets the raw quantile value.

Trait Implementations

impl PartialEq<Quantile> for Quantile

fn eq(&self, other: &Quantile) -> bool

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

fn ne(&self, other: &Quantile) -> bool

This method tests for !=.

impl Clone for Quantile

fn clone(&self) -> Quantile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quantile

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

Formats the value using the given formatter.