Struct ic_utils::canister::Canister

pub struct Canister<'agent> { /* private fields */ }

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> Canister<'agent>

pub fn canister_id_<'canister: 'agent>(&'canister self) -> &'_ Principal

Get the canister ID of this canister.

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

Create an AsyncCallBuilder to do an update call.

pub fn query_<'canister: 'agent>(
    &'canister self,
    method_name: &str
) -> SyncCallBuilder<'agent, 'canister>

Create a SyncCallBuilder to do a query call.

pub async fn wait<'canister: 'agent, W>(
    &'canister self,
    request_id: RequestId,
    waiter: W
) -> Result<Vec<u8>, AgentError>where
    W: Waiter,

Call request_status on the RequestId in a loop and return the response as a byte vector.

pub fn clone_with_(&self, id: Principal) -> Self

Creates a copy of this canister, changing the canister ID to the provided principal.

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

Create a CanisterBuilder instance to build a canister abstraction.

Trait Implementations

impl<'agent> Clone for Canister<'agent>

fn clone(&self) -> Canister<'agent>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'agent> Debug for Canister<'agent>

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

Formats the value using the given formatter.