Struct MemoryStats 

pub struct MemoryStats {
    pub active: usize,
    pub peak: usize,
    pub cache: usize,
    pub memory_limit: usize,
    pub cache_limit: usize,
    pub system_allocations: u64,
    pub wired_limit: usize,
    pub wired: usize,
    pub mapped: usize,
    pub wired_mapped: usize,
}

Memory use and limits of a device’s allocator, in bytes.

Fields

active: usize

Bytes in live buffers (rounded allocation sizes).

peak: usize

Highest active since creation or the last Device::reset_peak.

cache: usize

Bytes held in the cache for reuse.

memory_limit: usize

Allocations that would push active past this fail.

cache_limit: usize

The cache is trimmed to at most this many bytes.

system_allocations: u64

Buffers obtained from Metal (cache misses) so far.

wired_limit: usize

Buffers are kept resident up to this many bytes (see Device::set_wired_limit).

wired: usize

Bytes currently wired, including wired_mapped.

mapped: usize

Bytes of live memory-mapped files (checkpoints loaded without a copy). They are not in active or peak, which count the allocator’s own buffers only; MLX copies weights into its allocator, so its active includes them.

wired_mapped: usize

The part of wired that belongs to memory-mapped files.

Trait Implementations

impl Clone for MemoryStats

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryStats

impl Debug for MemoryStats

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

Formats the value using the given formatter.

impl Eq for MemoryStats

impl PartialEq for MemoryStats

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MemoryStats