Skip to main content

IcRuntime

Struct IcRuntime 

Source
pub struct IcRuntime { /* private fields */ }
Expand description

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§

Source§

impl IcRuntime

Source

pub fn new() -> Self

Create a new instance of IcRuntime.

Trait Implementations§

Source§

impl Clone for IcRuntime

Source§

fn clone(&self) -> IcRuntime

Returns a duplicate 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 Debug for IcRuntime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IcRuntime

Source§

fn default() -> IcRuntime

Returns the “default value” for a type. Read more
Source§

impl PartialEq for IcRuntime

Source§

fn eq(&self, other: &IcRuntime) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Runtime for IcRuntime

Source§

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.
Source§

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.
Source§

impl Copy for IcRuntime

Source§

impl Eq for IcRuntime

Source§

impl StructuralPartialEq for IcRuntime

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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>,

Source§

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.