Struct dhat::HeapStats

#[non_exhaustive]
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,
}

Stats from heap profiling.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

total_blocks: u64

Number of blocks (a.k.a. allocations) allocated over the entire run.

total_bytes: u64

Number of bytes allocated over the entire run.

curr_blocks: usize

Number of blocks (a.k.a. allocations) currently allocated.

curr_bytes: usize

Number of bytes currently allocated.

max_blocks: usize

Number of blocks (a.k.a. allocations) allocated at the global peak, i.e. when curr_bytes peaked.

max_bytes: usize

Number of bytes allocated at the global peak, i.e. when curr_bytes peaked.

Implementations

impl HeapStats

pub fn get() -> Self

Gets the current heap stats.

Panics

Panics if called when a Profiler is not running or not doing heap profiling.

Trait Implementations

impl Clone for HeapStats

fn clone(&self) -> HeapStats

Returns a copy 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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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