Struct MemorySnapshot 

pub struct MemorySnapshot {
    pub total_bytes: u64,
    pub available: MetricState<u64>,
    pub used: MetricState<u64>,
    pub free: MetricState<u64>,
    pub usage: MetricState<Percent>,
    pub detail: MemoryDetail,
    pub swap: SwapSnapshot,
    pub semantics: MemorySemantics,
    pub cgroup_limit_bytes: MetricState<u64>,
}

System memory state.

Fields

total_bytes: u64

Total physical memory. Always known.

available: MetricState<u64>

Memory allocatable without reclaim pressure, per Self::semantics.

used: MetricState<u64>

total_bytes - available, per Self::semantics.

free: MetricState<u64>

Completely unused memory. Usually much smaller than available.

usage: MetricState<Percent>

Share of memory in use.

detail: MemoryDetail

The secondary breakdown.

swap: SwapSnapshot

Swap capacity and activity.

semantics: MemorySemantics

Which definition produced available and used.

cgroup_limit_bytes: MetricState<u64>

The cgroup memory limit, when running under one, alongside the host total in total_bytes.

§9.2 requires container limits to be exposed separately from host totals and both to be shown and labelled where observable.

Implementations

impl MemorySnapshot

pub const fn warming_up(total_bytes: u64, semantics: MemorySemantics) -> Self

A snapshot with only the total known, for the first frame.

pub fn effective_limit_bytes(&self) -> u64

The memory ceiling that actually applies to this process tree.

Inside a container this is the cgroup limit, not the host total; §9.2 requires the distinction to be observable rather than silently folded into one number.

Trait Implementations

impl Clone for MemorySnapshot

fn clone(&self) -> MemorySnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemorySnapshot

impl Debug for MemorySnapshot

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

Formats the value using the given formatter.

impl PartialEq for MemorySnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MemorySnapshot