Struct MemoryGauge 

pub struct MemoryGauge { /* private fields */ }

Producer-side handle to an AtomicReporter’s gauge.

Cheap to clone (one Arc). Threaded into a subsystem so it can publish its live footprint. A MemoryGauge::disconnected gauge writes to a private atomic nobody reads — handy so subsystem code always has a gauge to write to even when not running under a registered budget (tests or applications without a budget).

Implementations

impl MemoryGauge

pub fn disconnected() -> Self

A gauge not wired to any reporter; updates go nowhere.

pub fn set(&self, bytes: u64)

Replace the reported byte count.

pub fn add(&self, bytes: u64)

Add to the reported byte count.

pub fn sub(&self, bytes: u64)

Subtract from the reported byte count, saturating at zero.

pub fn current(&self) -> u64

Current reported byte count.

pub fn guard(&self, bytes: u64) -> GaugeGuard

RAII attribution: add bytes to the gauge now and subtract the same amount when the returned GaugeGuard drops. Hold one alongside a resident allocation to attribute it to this gauge’s reporter for exactly that allocation’s lifetime. Uses add/sub so concurrent guards on the same reporter compose into one total.

Trait Implementations

impl Clone for MemoryGauge

fn clone(&self) -> MemoryGauge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryGauge

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

Formats the value using the given formatter.