Skip to main content

AllocationStats

Struct AllocationStats 

Source
pub struct AllocationStats {
    pub total_bytes: u64,
    pub total_blocks: u64,
    pub peak_bytes: u64,
    pub peak_blocks: u64,
}
Available on crate feature alloc-tracking only.
Expand description

Snapshot of allocation activity, captured from mod_alloc::dhat_compat::HeapStats (drop-in for dhat::HeapStats).

Build via AllocationStats::snapshot inside a mod_alloc::dhat_compat::Profiler scope.

Fields§

§total_bytes: u64

Total bytes allocated across the profiled scope (cumulative).

§total_blocks: u64

Total number of allocations across the profiled scope.

§peak_bytes: u64

Peak bytes resident at any one time.

§peak_blocks: u64

Peak number of blocks resident at any one time.

Implementations§

Source§

impl AllocationStats

Source

pub fn snapshot() -> Self

Capture the current HeapStats into an AllocationStats.

SHOULD be called inside an active mod_alloc::dhat_compat::Profiler::new_heap() scope so the profiler’s drop-time JSON write captures the same data. The snapshot itself works outside a Profiler scope (returns zeros if no global allocator is installed); the historical dhat-rs panic is no longer present.

Source

pub fn compare_against_baseline( &self, name: &str, baseline: Option<AllocationStats>, pct_threshold: f64, ) -> CheckResult

Compare this snapshot against a baseline.

pct_threshold is the maximum tolerated growth in total_bytes over the baseline. A regression beyond the threshold yields Fail (Warning). No baseline yields Skip.

Trait Implementations§

Source§

impl Clone for AllocationStats

Source§

fn clone(&self) -> AllocationStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for AllocationStats

Source§

impl Debug for AllocationStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for AllocationStats

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AllocationStats

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.