Struct Canister 

pub struct Canister(/* private fields */);

Implementations

impl Canister

pub async fn create( settings: Option<CanisterSettings>, cycles: u64, ) -> Result<Self, (RejectionCode, String)>

pub fn accept_cycles() -> u64

A helper method to accept cycles from caller.

pub async fn provisional_create_with_cycles( amount: u64, settings: Option<CanisterSettings>, ) -> Result<Self, (RejectionCode, String)>

pub async fn update_settings( &self, settings: CanisterSettings, ) -> Result<(), (RejectionCode, String)>

pub async fn install_code<T: ArgumentEncoder>( &self, mode: InstallCodeMode, wasm_module: WasmModule, arg: T, ) -> Result<(), (RejectionCode, String)>

pub async fn uninstall_code(&self) -> Result<(), (RejectionCode, String)>

pub async fn start(&self) -> Result<(), (RejectionCode, String)>

pub async fn stop(&self) -> Result<(), (RejectionCode, String)>

pub async fn status(&self) -> Result<CanisterStatus, (RejectionCode, String)>

pub async fn delete(&self) -> Result<(), (RejectionCode, String)>

pub async fn deposit_cycles(&self) -> Result<(), (RejectionCode, String)>

pub async fn raw_rand(&self) -> Result<Vec<u8>, (RejectionCode, String)>

pub async fn provisional_top_up( &self, amount: u128, ) -> Result<(), (RejectionCode, String)>

Trait Implementations

impl AsRef<Principal> for Canister

fn as_ref(&self) -> &CanisterID

Converts this type into a shared reference of the (usually inferred) input type.

impl CandidType for Canister

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 Canister

fn clone(&self) -> Canister

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Canister

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Canister

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Canister> for CanisterID

fn from(canister: Canister) -> Self

Converts to this type from the input type.

impl From<Principal> for Canister

fn from(id: CanisterID) -> Self

Converts to this type from the input type.

impl Hash for Canister

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 Canister

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

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

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

impl Eq for Canister

impl StructuralPartialEq for Canister