Struct metriken::histogram::RwLockHistogram

pub struct RwLockHistogram { /* private fields */ }

A histogram that uses free-running non-atomic counters to track the distribution of values. They are only useful for bulk recording of values and producing [crate::Snapshot]s of the histogram state which can then be used for reporting.

The AtomicHistogram should be preferred when individual events are being recorded. The RwLockHistogram should be preferred when bulk-updating the histogram from pre-aggregated data with a compatible layout.

Implementations

impl RwLockHistogram

pub const fn new(grouping_power: u8, max_value_power: u8) -> Self

Create a new ::histogram::AtomicHistogram with the given parameters.

Panics

This will panic if the grouping_power and max_value_power do not adhere to the following constraints:

• max_value_power must be in the range 1..=64
• grouping_power must be in the range 0..=(max_value_power - 1)

pub fn update_from(&self, data: &[u64]) -> Result<(), Error>

Updates the histogram counts from raw data.

pub fn config(&self) -> Config

pub fn load(&self) -> Option<Histogram>

Loads and returns the histogram. Returns None if the histogram has never been incremented.

Trait Implementations

impl Metric for RwLockHistogram

fn as_any(&self) -> Option<&dyn Any>

Get the current metric as an Any instance. This is meant to allow custom processing for known metric types.

fn value(&self) -> Option<Value<'_>>

Get the value of the current metric, should it be enabled.

fn is_enabled(&self) -> bool

Indicate whether this metric has been set up.