Struct ScoreHistogram 

pub struct ScoreHistogram { /* private fields */ }

Fixed-bin histogram over an f64 stream.

Implementations

impl ScoreHistogram

pub fn new(config: HistogramConfig) -> RcfResult<Self>

Build a fresh histogram with the supplied config.

Errors

Forwards HistogramConfig::validate errors.

pub fn with_range(min: f64, max: f64) -> RcfResult<Self>

Short-hand for new(HistogramConfig::with_range(min, max)?).

Errors

Same as Self::new.

pub fn record(&mut self, value: f64)

Fold value into the histogram.

pub fn bins(&self) -> &[u64]

Read-only view of the per-bin counts, in ascending-value order.

pub fn bin_edges(&self) -> Vec<(f64, f64)>

Inclusive/exclusive edges of every bin — [(min_0, max_0), (min_1, max_1), …]. Useful for Prometheus-style export where each bucket is named by its upper bound.

pub fn config(&self) -> &HistogramConfig

Configured bin layout.

pub fn underflow(&self) -> u64

Observations below HistogramConfig::min.

pub fn overflow(&self) -> u64

Observations at or above HistogramConfig::max.

pub fn non_finite(&self) -> u64

Non-finite observations (NaN, ±∞).

pub fn total(&self) -> u64

Total number of record calls — sum of every bin, underflow, overflow, and non-finite.

pub fn reset(&mut self)

Drop every count, keeping the config.

pub fn merge(&mut self, other: &Self) -> RcfResult<()>

Merge other into self. Both histograms must share the exact same config.

Errors

Returns RcfError::InvalidConfig when the configs differ.

pub fn percentile(&self, p: f64) -> Option<f64>

Linear-interpolated percentile of the recorded values. Returns None when p is outside [0, 1] or the histogram has seen no in-range observations. Under-/overflow and non-finite counts are excluded from the percentile.

Trait Implementations

impl Clone for ScoreHistogram

fn clone(&self) -> ScoreHistogram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScoreHistogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScoreHistogram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScoreHistogram

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScoreHistogram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScoreHistogram