Struct MemoryQuotaTracker 

pub struct MemoryQuotaTracker {
    state: IfEnabled<Mutex<State>>,
}

Memory data tracker

Instance of the memory quota system.

Usually found as Arc<MemoryQuotaTracker>.

Fields

state: IfEnabled<Mutex<State>>

The actual tracker state etc.

Implementations

impl MemoryQuotaTracker

pub fn new<R: Spawn>( runtime: &R, config: Config, ) -> Result<Arc<Self>, StartupError>

Set up a new MemoryDataTracker

pub fn reconfigure( &self, new_config: Config, how: Reconfigure, ) -> Result<(), ReconfigureError>

Reconfigure

pub fn used_current_approx(&self) -> Result<usize, TrackerCorrupted>

Returns an estimate of the total memory use

The returned value is:

• Approximate.
• A snapshot as of the current moment (and there is no way to await changes)
• Always usize::MAX for a no-op tracker

pub fn new_account( self: &Arc<Self>, parent: Option<&Account>, ) -> Result<Account>

Make a new Account

To actually record memory usage, a Participant must be added.

At most call sites, take an Account rather than a MemoryQuotaTracker, and use Account::new_child(). That improves the ability to manage the hierarchy of Participants.

pub fn new_noop() -> Arc<MemoryQuotaTracker>

Obtain a new MemoryQuotaTracker that doesn’t track anything and never reclaims

fn lock(&self) -> Result<IfEnabled<MutexGuard<'_, State>>, TrackerCorrupted>

Obtain the lock on the state

Trait Implementations

impl Debug for MemoryQuotaTracker

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

Formats the value using the given formatter.