Struct ic_cdk::api::management_canister::main::CanisterSettings

pub struct CanisterSettings {
    pub controllers: Option<Vec<Principal>>,
    pub compute_allocation: Option<Nat>,
    pub memory_allocation: Option<Nat>,
    pub freezing_threshold: Option<Nat>,
    pub reserved_cycles_limit: Option<Nat>,
    pub wasm_memory_limit: Option<Nat>,
}

Canister settings.

The settings are optional. If they are not explicitly set, the default values will be applied automatically.

See settings.

Fields

controllers: Option<Vec<Principal>>

A list of at most 10 principals.

The principals in this list become the controllers of the canister.

Default value: A list containing only the caller of the create_canister call.

compute_allocation: Option<Nat>

Must be a number between 0 and 100, inclusively.

It indicates how much compute power should be guaranteed to this canister, expressed as a percentage of the maximum compute power that a single canister can allocate.

If the IC cannot provide the requested allocation, for example because it is oversubscribed, the call will be rejected.

Default value: 0

memory_allocation: Option<Nat>

Must be a number between 0 and 2⁴⁸ (i.e 256TB), inclusively.

It indicates how much memory the canister is allowed to use in total.

If the IC cannot provide the requested allocation, for example because it is oversubscribed, the call will be rejected.

If set to 0, then memory growth of the canister will be best-effort and subject to the available memory on the IC.

Default value: 0

freezing_threshold: Option<Nat>

Must be a number between 0 and 2⁶⁴-1, inclusively.

It indicates a length of time in seconds.

Default value: 2592000 (approximately 30 days).

reserved_cycles_limit: Option<Nat>

Must be a number between 0 and 2¹²⁸-1, inclusively.

It indicates the upper limit on reserved_cycles of the canister.

Default value: 5_000_000_000_000 (5 trillion cycles).

wasm_memory_limit: Option<Nat>

Must be a number between 0 and 2⁴⁸-1 (i.e 256TB), inclusively.

It indicates the upper limit on the WASM heap memory consumption of the canister.

Default value: 3_221_225_472 (3 GiB).

Trait Implementations

impl CandidType for CanisterSettings

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 CanisterSettings

fn clone(&self) -> CanisterSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterSettings

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

Formats the value using the given formatter.

impl Default for CanisterSettings

fn default() -> CanisterSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanisterSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CanisterSettings

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 CanisterSettings

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CanisterSettings

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for CanisterSettings

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 CanisterSettings

impl StructuralPartialEq for CanisterSettings