Struct HeapStats 

pub struct HeapStats {
    pub total_blocks: u64,
    pub total_bytes: u64,
    pub curr_blocks: usize,
    pub curr_bytes: usize,
    pub max_blocks: usize,
    pub max_bytes: usize,
}

Available on crate feature dhat-compat only.

Heap-mode statistics snapshot. Mirrors the shape of dhat::HeapStats field-for-field so consumers migrating from dhat can drop in the type alias without code edits.

Note the total_* fields are u64 while curr_* and max_* are usize — this matches dhat-rs exactly. On 32-bit targets the u64 -> usize casts in HeapStats::get are saturating; in practice mod-alloc targets 64-bit only (the Tier 2 walker requires x86_64 / aarch64).

Example

use mod_alloc::dhat_compat::{Alloc, HeapStats};

#[global_allocator]
static ALLOC: Alloc = Alloc;

let _v: Vec<u8> = vec![0; 1024];
let stats = HeapStats::get();
assert!(stats.total_bytes >= 1024);

Fields

total_blocks: u64

Total blocks ever allocated (lifetime count).

total_bytes: u64

Total bytes ever allocated (lifetime sum).

curr_blocks: usize

Currently-alive block count.

curr_bytes: usize

Currently-resident bytes.

max_blocks: usize

Peak live block count.

max_bytes: usize

Peak resident bytes.

Implementations

impl HeapStats

pub fn get() -> Self

Snapshot the current heap statistics from the installed allocator.

If no crate::dhat_compat::Alloc (or crate::ModAlloc) is installed as #[global_allocator] and no allocation has occurred yet, all fields are zero.

Examples found in repository

examples/dhat_drop_in.rs (line 45)

fn main() {
    let _profiler = dhat::Profiler::new_heap();

    for _ in 0..500 {
        alloc_small();
    }
    for _ in 0..100 {
        alloc_medium();
    }

    let stats = dhat::HeapStats::get();
    println!(
        "total_blocks: {}, total_bytes: {}, max_bytes: {}, curr_blocks: {}",
        stats.total_blocks, stats.total_bytes, stats.max_bytes, stats.curr_blocks,
    );
    println!("_profiler drops at end of main → writes dhat-heap.json");
}

Trait Implementations

impl Clone for HeapStats

fn clone(&self) -> HeapStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeapStats

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

Formats the value using the given formatter.

impl PartialEq for HeapStats

fn eq(&self, other: &HeapStats) -> 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 Eq for HeapStats

impl StructuralPartialEq for HeapStats