Struct CanisterStatusResult 

pub struct CanisterStatusResult {
    pub status: CanisterStatusType,
    pub ready_for_migration: bool,
    pub version: u64,
    pub settings: DefiniteCanisterSettings,
    pub module_hash: Option<Vec<u8>>,
    pub memory_size: Nat,
    pub memory_metrics: MemoryMetrics,
    pub cycles: Nat,
    pub reserved_cycles: Nat,
    pub idle_cycles_burned_per_day: Nat,
    pub query_stats: QueryStats,
}

Canister Status Result

Result type of canister_status.

Fields

status: CanisterStatusType

Status of the canister.

ready_for_migration: bool

Indicates whether a stopped canister is ready to be migrated to another subnet (i.e., whether it has empty queues and flushed streams).

version: u64

The canister version.

settings: DefiniteCanisterSettings

Canister settings in effect.

module_hash: Option<Vec<u8>>

A SHA256 hash of the module installed on the canister. This is null if the canister is empty.

memory_size: Nat

The memory size taken by the canister.

memory_metrics: MemoryMetrics

The detailed metrics on the memory consumption of the canister.

cycles: Nat

The cycle balance of the canister.

reserved_cycles: Nat

The reserved cycles balance of the canister.

These are cycles that are reserved by the resource reservation mechanism on storage allocation. See also the CanisterSettings::reserved_cycles_limit parameter in canister settings.

idle_cycles_burned_per_day: Nat

Amount of cycles burned per day.

query_stats: QueryStats

Query statistics.

Trait Implementations

impl CandidType for CanisterStatusResult

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for CanisterStatusResult

fn clone(&self) -> CanisterStatusResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterStatusResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanisterStatusResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CanisterStatusResult

impl Hash for CanisterStatusResult

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 CanisterStatusResult

fn cmp(&self, other: &CanisterStatusResult) -> 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 CanisterStatusResult

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CanisterStatusResult

fn partial_cmp(&self, other: &CanisterStatusResult) -> 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 CanisterStatusResult

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 StructuralPartialEq for CanisterStatusResult