Struct 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 log_visibility: Option<LogVisibility>,
    pub log_memory_limit: Option<Nat>,
    pub snapshot_visibility: Option<SnapshotVisibility>,
    pub wasm_memory_limit: Option<Nat>,
    pub wasm_memory_threshold: Option<Nat>,
    pub environment_variables: Option<Vec<EnvironmentVariable>>,
}

Canister Settings

For arguments of create_canister, update_settings and provisional_create_canister_with_cycles.

All fields are Option types, allowing selective settings/updates.

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>

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.

Must be a number between 0 and 100, inclusively.

Default value: 0

memory_allocation: Option<Nat>

Indicates how much memory (bytes) 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.

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

Default value: 0

freezing_threshold: Option<Nat>

Indicates a length of time in seconds. A canister is considered frozen whenever the IC estimates that the canister would be depleted of cycles before freezing_threshold seconds pass, given the canister’s current size and the IC’s current cost for storage.

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

Default value: 2_592_000 (approximately 30 days).

reserved_cycles_limit: Option<Nat>

Indicates the upper limit on CanisterStatusResult::reserved_cycles of the canister.

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

Default value: 5_000_000_000_000 (5 trillion cycles).

log_visibility: Option<LogVisibility>

Defines who is allowed to read the canister’s logs.

Default value: LogVisibility::Controllers.

log_memory_limit: Option<Nat>

Indicates the upper limit on the memory used for canister logs (bytes).

Default value: 4096.

snapshot_visibility: Option<SnapshotVisibility>

Defines who is allowed to read the canister’s snapshots.

Default value: SnapshotVisibility::Controllers.

wasm_memory_limit: Option<Nat>

Indicates the upper limit on the WASM heap memory (bytes) consumption of the canister.

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

Default value: 3_221_225_472 (3 GiB).

wasm_memory_threshold: Option<Nat>

Indicates the threshold on the remaining wasm memory size of the canister in bytes.

If the remaining wasm memory size of the canister is below the threshold, execution of the “on low wasm memory” hook is scheduled.

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

Default value: 0 (i.e., the “on low wasm memory” hook is never scheduled).

environment_variables: Option<Vec<EnvironmentVariable>>

A list of environment variables.

These variables are accessible to the canister during execution and can be used to configure canister behavior without code changes. Each key must be unique.

Default value: null (i.e., no environment variables provided).

Trait Implementations

impl CandidType for CanisterSettings

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 CanisterSettings

fn clone(&self) -> CanisterSettings

Returns a duplicate 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<(), Error>

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<CanisterSettings, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CanisterSettings

impl Hash for CanisterSettings

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 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for CanisterSettings

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

Equality operator ==.

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

Inequality operator !=.

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

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 CanisterSettings

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 CanisterSettings