Struct MemoryMetrics 

pub struct MemoryMetrics {
    pub wasm_memory_size: Nat,
    pub stable_memory_size: Nat,
    pub global_memory_size: Nat,
    pub wasm_binary_size: Nat,
    pub custom_sections_size: Nat,
    pub canister_history_size: Nat,
    pub wasm_chunk_store_size: Nat,
    pub snapshots_size: Nat,
}

Memory Metrics

Memory metrics of a canister.

See CanisterStatusResult::memory_metrics.

Fields

wasm_memory_size: Nat

Represents the Wasm memory usage of the canister, i.e. the heap memory used by the canister’s WebAssembly code.

stable_memory_size: Nat

Represents the stable memory usage of the canister.

global_memory_size: Nat

Represents the memory usage of the global variables that the canister is using.

wasm_binary_size: Nat

Represents the memory occupied by the Wasm binary that is currently installed on the canister.

custom_sections_size: Nat

Represents the memory used by custom sections defined by the canister.

canister_history_size: Nat

Represents the memory used for storing the canister’s history.

wasm_chunk_store_size: Nat

Represents the memory used by the Wasm chunk store of the canister.

snapshots_size: Nat

Represents the memory consumed by all snapshots that belong to this canister.

Trait Implementations

impl CandidType for MemoryMetrics

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>( &self, __serializer: __S, ) -> Result<(), <__S as Serializer>::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for MemoryMetrics

fn clone(&self) -> MemoryMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryMetrics

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MemoryMetrics

fn deserialize<__D>( __deserializer: __D, ) -> Result<MemoryMetrics, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MemoryMetrics

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MemoryMetrics

fn cmp(&self, other: &MemoryMetrics) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MemoryMetrics

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

fn partial_cmp(&self, other: &MemoryMetrics) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MemoryMetrics

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MemoryMetrics

impl StructuralPartialEq for MemoryMetrics