Struct ic_cdk::api::management_canister::main::CanisterStatusResponse

pub struct CanisterStatusResponse {
    pub status: CanisterStatusType,
    pub settings: DefiniteCanisterSettings,
    pub module_hash: Option<Vec<u8>>,
    pub memory_size: Nat,
    pub cycles: Nat,
    pub idle_cycles_burned_per_day: Nat,
    pub query_stats: QueryStats,
    pub reserved_cycles: Nat,
}

Return type of canister_status.

Fields

status: CanisterStatusType

See CanisterStatusType.

settings: DefiniteCanisterSettings

See DefiniteCanisterSettings.

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.

cycles: Nat

The cycle balance of the canister.

idle_cycles_burned_per_day: Nat

Amount of cycles burned per day.

query_stats: QueryStats

Query statistics

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 reserved_cycles_limit parameter in canister settings.

Trait Implementations

impl CandidType for CanisterStatusResponse

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for CanisterStatusResponse

fn clone(&self) -> CanisterStatusResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterStatusResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanisterStatusResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CanisterStatusResponse

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

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 CanisterStatusResponse

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

Restrict a value to a certain interval.

impl PartialEq for CanisterStatusResponse

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CanisterStatusResponse

impl StructuralPartialEq for CanisterStatusResponse