Struct AllocStats 

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

// Construct via Default (literal construction is closed off as
// of v1.0 — see "Stability" below).
let mut stats = AllocStats::default();
stats.alloc_count = 10;
stats.total_bytes = 1024;
assert_eq!(stats.alloc_count, 10);

Stability

Marked #[non_exhaustive] as of v1.0.0. New counter fields may be added in future minor versions without bumping the major version. Construct via AllocStats::default (or consume snapshots from ModAlloc::snapshot / Profiler::stop) rather than struct-literal syntax. Reading individual fields by name is fully stable.

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.

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 Default for AllocStats

fn default() -> AllocStats

Returns the “default value” for a type.

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