Struct IcRuntime 

pub struct IcRuntime { /* private fields */ }

Runtime when interacting with a canister running on the Internet Computer.

Examples

Call the make_http_post_request endpoint on the example http_canister.

use candid::Principal;
use ic_canister_runtime::{IcRuntime, Runtime, StubRuntime};

let runtime = IcRuntime::new();
let http_request_result: String = runtime
    .update_call(canister_id, "make_http_post_request", (), 0)
    .await
    .expect("Call to `http_canister` failed");

assert!(http_request_result.contains("Hello, World!"));
assert!(http_request_result.contains("\"X-Id\": \"42\""));

Implementations

impl IcRuntime

pub fn new() -> Self

Create a new instance of IcRuntime.

pub fn allow_calls_when_stopping(self, allow: bool) -> Self

Allow inter-canister calls when the canister is stopping.

Allowing inter-canister calls when the canister making the calls is stopping could prevent that canister from being stopped and therefore upgraded. This is because the stopping state does not prevent the canister itself from issuing new calls (see the specification on stop_canister).

Trait Implementations

impl Clone for IcRuntime

fn clone(&self) -> IcRuntime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcRuntime

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

Formats the value using the given formatter.

impl Default for IcRuntime

fn default() -> IcRuntime

Returns the “default value” for a type.

impl PartialEq for IcRuntime

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

fn update_call<'life0, 'life1, 'async_trait, In, Out>( &'life0 self, id: Principal, method: &'life1 str, args: In, cycles: u128, ) -> Pin<Box<dyn Future<Output = Result<Out, IcError>> + Send + 'async_trait>>

where In: ArgumentEncoder + Send + 'async_trait, Out: CandidType + DeserializeOwned + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Defines how asynchronous inter-canister update calls are made.

fn query_call<'life0, 'life1, 'async_trait, In, Out>( &'life0 self, id: Principal, method: &'life1 str, args: In, ) -> Pin<Box<dyn Future<Output = Result<Out, IcError>> + Send + 'async_trait>>

where In: ArgumentEncoder + Send + 'async_trait, Out: CandidType + DeserializeOwned + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Defines how asynchronous inter-canister query calls are made.

impl Copy for IcRuntime

impl Eq for IcRuntime

impl StructuralPartialEq for IcRuntime