Struct HeapSnapshot 

#[non_exhaustive]
pub struct HeapSnapshot {
    pub frame: u32,
    pub live_bytes: u64,
    pub peak_bytes: u64,
    pub tags: Vec<TagRow>,
    pub overflowed: u32,
}

What holds the heap at a frame (ADR-0046 §6): its live bytes, and each memory tag’s counts. Build it with HeapSnapshot::new (ADR-0039), which puts the rows in order; compare two with diff.

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.

frame: u32

The frame it was taken after (frames count from 1; 0 is before the first).

live_bytes: u64

The bytes allocated and not yet freed.

peak_bytes: u64

The most bytes live at once since the program started.

tags: Vec<TagRow>

Each tag with bytes live or ever allocated under it: the most live bytes first, then by class, then by name.

overflowed: u32

How many names had no tag of their own, past the counter’s table, and count under overflow.

Implementations

impl HeapSnapshot

pub fn new(live_bytes: u64, peak_bytes: u64, tags: Vec<TagRow>) -> Self

A snapshot of frame 0 with live_bytes live, peak_bytes at the most, and the rows tags, put in order: the most live bytes first, then by class, then by name. None overflowed.

pub fn diff(&self, later: &HeapSnapshot) -> HeapDiff

What changed from this snapshot to later: the tags whose live bytes or blocks changed, a tag missing from one counting as 0 there.

Trait Implementations

impl Clone for HeapSnapshot

fn clone(&self) -> HeapSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeapSnapshot

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

Formats the value using the given formatter.

impl Default for HeapSnapshot

fn default() -> HeapSnapshot

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HeapSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HeapSnapshot

impl JsonSchema for HeapSnapshot

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for HeapSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HeapSnapshot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HeapSnapshot