Struct Ledger 

pub struct Ledger { /* private fields */ }

The tagged accounting itself. One process-global instance backs the engine (crate::ledger()); the type is public so the accounting is testable on its own instance.

Implementations

impl Ledger

pub const fn new() -> Self

A ledger with every cell at zero and no budgets set.

pub fn add(&self, tag: MemTag, realm: Realm, bytes: u64)

Take on bytes under tag. For a subsystem that grows and shrinks in increments; one that knows its total should set it instead.

pub fn release(&self, tag: MemTag, realm: Realm, bytes: u64)

Give up bytes under tag. Saturates at zero: a reporter that double-releases should read as holding nothing, never as holding an enormous amount.

pub fn set(&self, tag: MemTag, realm: Realm, bytes: u64)

Declare the tag’s whole holding. Idempotent, so a pool that recomputes its resident bytes each frame cannot drift the way paired add/release calls can.

pub fn set_budget(&self, tag: MemTag, realm: Realm, budget: Option<u64>)

The ceiling the tag is expected to stay under. None clears it.

pub fn usage(&self, tag: MemTag, realm: Realm) -> TagUsage

Set (or clear, with None) the byte budget for one tag and realm.

pub fn snapshot(&self) -> LedgerSnapshot

One tag’s current usage in one realm.

pub fn clear(&self)

Drop every report and budget, including the peaks. For a host tearing a world down and building another, whose old numbers describe nothing.

Trait Implementations

impl Default for Ledger

fn default() -> Self

Returns the “default value” for a type.