Struct ic_utils::canister::Canister

pub struct Canister<'agent, T = ()> { /* fields omitted */ }

Create an encapsulation of a Canister running on the Internet Computer. This supports making calls to methods, installing code if needed, and various utilities related to a canister.

This is the higher level construct for talking to a canister on the Internet Computer.

Implementations

impl<'agent, T> Canister<'agent, T>

pub fn interface_(&self) -> &T

Get the interface object from this canister. Sometimes those interfaces might have custom methods that are useful.

pub fn update_<'canister>(
    &'canister self,
    method_name: &str
) -> AsyncCallBuilder<'agent, 'canister, T>

Create an AsyncCallBuilder to do an update call.

impl<'agent> Canister<'agent, ()>

pub fn builder() -> CanisterBuilder<'agent, ()>

Create a CanisterBuilder instance to build a canister abstraction.

impl<'agent> Canister<'agent, ManagementCanister>

pub fn canister_status<'canister: 'agent>(
    &'canister self,
    canister_id: &Principal
) -> impl 'agent + AsyncCall<(CanisterStatus,)>

Get the status of a canister.

pub fn create_canister<'canister: 'agent>(
    &'canister self
) -> impl 'agent + AsyncCall<(Principal,)>

Create a canister, returning a caller that returns a Canister Id.

pub fn delete_canister<'canister: 'agent>(
    &'canister self,
    canister_id: &Principal
) -> impl 'agent + AsyncCall<()>

Deletes a canister.

pub fn start_canister<'canister: 'agent>(
    &'canister self,
    canister_id: &Principal
) -> impl 'agent + AsyncCall<()>

Starts a canister.

pub fn stop_canister<'canister: 'agent>(
    &'canister self,
    canister_id: &Principal
) -> impl 'agent + AsyncCall<()>

Stop a canister.

pub fn install_code<'canister: 'agent>(
    &'canister self,
    canister_id: &Principal,
    wasm: &'canister [u8]
) -> InstallCodeBuilder<'agent, 'canister, ManagementCanister>

Install a canister, with all the arguments necessary for creating the canister.