Struct HistogramConfig 

pub struct HistogramConfig { /* private fields */ }

Configuration for histogram precision.

Controls the number of significant figures used when recording histogram values, affecting both precision and memory usage.

Example

use rylv_metrics::{HistogramConfig, SigFig};
let config = HistogramConfig::new(SigFig::TWO, vec![0.95, 0.99]).unwrap();

Implementations

impl HistogramConfig

pub fn new(sig_fig: SigFig, percentiles: Vec<f64>) -> MetricResult<Self>

Creates a new histogram configuration with the given significant figures and percentiles.

Errors

Returns an error if any percentile is NaN/inf or outside [0.0, 1.0).

pub fn with_base_metrics( self, emit_base_metrics: impl IntoIterator<Item = HistogramBaseMetric>, ) -> Self

Replaces the set of emitted base histogram metrics.

pub const fn with_count(self, emit: bool) -> Self

Enables or disables the .count histogram metric.

pub const fn with_min(self, emit: bool) -> Self

Enables or disables the .min histogram metric.

pub const fn with_avg(self, emit: bool) -> Self

Enables or disables the .avg histogram metric.

Note: .avg currently reflects p50 behavior for compatibility.

pub const fn with_max(self, emit: bool) -> Self

Enables or disables the .max histogram metric.

pub fn with_bounds(self, min: u64, max: u64) -> MetricResult<Self>

Sets histogram recording bounds.

These bounds determine the compatible pool and the histogram allocation shape.

Errors

Returns an error if min < 1 or max < min.

Trait Implementations

impl Clone for HistogramConfig

fn clone(&self) -> HistogramConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramConfig

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

Formats the value using the given formatter.

impl Default for HistogramConfig

fn default() -> Self

Returns the “default value” for a type.