Struct Batched 

pub struct Batched<M: Batchable> { /* private fields */ }

A metric handle that publishes one writer’s updates to a shared metric in batches.

The handle keeps the writer’s total and adds the total’s change since the previous publication to the shared metric after every size updates and when the handle is dropped. The shared metric includes each update made before the writer’s latest publication exactly once, and none made after it.

Writers that update one shared metric directly contend on its cache line with every update. Giving each writer its own handle limits that to one update of the shared metric per batch.

Implementations

impl<M: Batchable> Batched<M>

pub fn new(shared: &Registered<M>, size: NonZeroU32) -> Self

Create a handle that publishes to shared’s metric after every size updates. The writer’s total starts at zero, and every update counts toward a batch, including one that leaves the total unchanged.

The handle does not hold shared’s registration, so the metric leaves the registry when the last Registered handle to it is dropped. This handle does not publish to a fresh metric registered under the same name afterwards.

pub const fn get(&self) -> M::Value

The writer’s total, including updates not yet published.

impl Batched<Counter>

pub fn inc(&mut self)

Increase the writer’s total by one.

pub fn inc_by(&mut self, value: u64)

Increase the writer’s total by value.

impl Batched<Gauge>

pub fn inc(&mut self)

Increase the writer’s total by one.

pub fn dec(&mut self)

Decrease the writer’s total by one.

pub fn inc_by(&mut self, value: GaugeValue)

Increase the writer’s total by value.

pub fn dec_by(&mut self, value: GaugeValue)

Decrease the writer’s total by value.

pub fn set(&mut self, value: GaugeValue)

Set the writer’s total to value.

Trait Implementations

impl<M: Batchable> Drop for Batched<M>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.