Struct Usage 

pub struct Usage {
    pub total: usize,
    pub used: usize,
    pub free: usize,
    pub objects: usize,
}

Memory usage information.

This structure is returned by Teaspoon::usage. See that method documentation for information and examples.

Fields

total: usize

Total memory available to the allocator.

This includes memory that may be used by the allocator for both allocated objects and internal structures. total usually matches the size passed to the Teaspoon constructor, but sometimes may be slightly lower due to align requirements.

Note that total does not equal used + free. That’s because used does not keep into account the overhead from the internal structures used by the allocator. The expression total - used - free may be used to calculate this overhead.

used: usize

Total memory used by allocated objects.

This is the sum of the usable data of each allocated object. It does not take into account the overhead from the internal structures used by the allocator.

free: usize

Memory unused by the allocator.

This is the total memory available, minus all the allocated memory, minus all the memory used by internal structures. Note that trying to allocate an object of size equal to (or close to) free may not succeed, due to overheads and memory fragmentation.

objects: usize

Number of objects currently allocated.

Allocating an object increments this number; deallocating an object decrements it; growing/shrinking an object does not alter this number.

Trait Implementations

impl Clone for Usage

fn clone(&self) -> Usage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usage

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

Formats the value using the given formatter.

impl Default for Usage

fn default() -> Usage

Returns the “default value” for a type.

impl PartialEq for Usage

fn eq(&self, other: &Usage) -> 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 Eq for Usage

impl StructuralPartialEq for Usage