Struct AllocStats 

pub struct AllocStats {
    pub alloc_count: u64,
    pub total_bytes: u64,
    pub peak_bytes: u64,
    pub current_bytes: u64,
    pub live_count: u64,
    pub peak_live_count: u64,
}

Snapshot of allocation statistics at a point in time.

Produced by ModAlloc::snapshot and Profiler::stop.

Example

use mod_alloc::AllocStats;

let stats = AllocStats {
    alloc_count: 10,
    total_bytes: 1024,
    peak_bytes: 512,
    current_bytes: 256,
    live_count: 4,
    peak_live_count: 7,
};
assert_eq!(stats.alloc_count, 10);

Version note

live_count and peak_live_count were added in v0.9.4 to support dhat-rs’s HeapStats shape via the dhat-compat feature. Callers constructing AllocStats via struct literal must initialise the new fields; callers that only consume AllocStats via ModAlloc::snapshot or Profiler::stop are unaffected.

Fields

alloc_count: u64

Number of allocations performed.

total_bytes: u64

Total bytes allocated across all allocations. Reallocations contribute the growth delta (or zero on shrink).

peak_bytes: u64

Peak resident bytes (highest current_bytes ever observed).

current_bytes: u64

Currently-allocated bytes (allocations minus deallocations).

live_count: u64

Currently-alive allocation count (allocations minus deallocations). Mirrors dhat::HeapStats::curr_blocks.

peak_live_count: u64

Peak live allocation count (highest live_count ever observed). Mirrors dhat::HeapStats::max_blocks.

Trait Implementations

impl Clone for AllocStats

fn clone(&self) -> AllocStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllocStats

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

Formats the value using the given formatter.

impl PartialEq for AllocStats

fn eq(&self, other: &AllocStats) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AllocStats

impl Eq for AllocStats

impl StructuralPartialEq for AllocStats