Struct ic_utils::canister::Canister

source ·
pub struct Canister<'agent> { /* private fields */ }
Expand description

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§

source§

impl<'agent> Canister<'agent>

source

pub fn canister_id_(&self) -> &Principal

Get the canister ID of this canister. Prefer using canister_id instead.

source

pub fn canister_id(&self) -> &Principal

Get the canister ID of this canister.

source

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

Create an AsyncCallBuilder to do an update call.

source

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

Create an AsyncCallBuilder to do an update call. Prefer using update instead.

source

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

Create a SyncCallBuilder to do a query call. Prefer using query instead.

source

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

Create a SyncCallBuilder to do a query call.

source

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

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

source

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

Creates a copy of this canister, changing the canister ID to the provided principal. Prefer using clone_with instead.

source

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

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

source

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

Create a CanisterBuilder instance to build a canister abstraction.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'agent> Freeze for Canister<'agent>

§

impl<'agent> !RefUnwindSafe for Canister<'agent>

§

impl<'agent> Send for Canister<'agent>

§

impl<'agent> Sync for Canister<'agent>

§

impl<'agent> Unpin for Canister<'agent>

§

impl<'agent> !UnwindSafe for Canister<'agent>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V