Skip to main content

AgentRuntime

Struct AgentRuntime 

Source
pub struct AgentRuntime<'a> { /* private fields */ }
Expand description

Runtime for interacting with a canister through an ic_agent::Agent. This can be useful when, e.g., contacting a canister via ingress messages instead of via another canister.

§Examples

Call the make_http_post_request endpoint on the example http_canister.

use ic_agent::agent::Agent;
use ic_agent_canister_runtime::AgentRuntime;
use ic_canister_runtime::Runtime;

let agent = Agent::builder().build().expect("Failed to initialize agent");
let runtime = AgentRuntime::new(&agent);
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<'a> AgentRuntime<'a>

Source

pub fn new(agent: &'a Agent) -> Self

Create a new AgentRuntime with the given Agent.

Trait Implementations§

Source§

impl<'a> Clone for AgentRuntime<'a>

Source§

fn clone(&self) -> AgentRuntime<'a>

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<'a> Debug for AgentRuntime<'a>

Source§

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

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

impl Runtime for AgentRuntime<'_>

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.

Auto Trait Implementations§

§

impl<'a> Freeze for AgentRuntime<'a>

§

impl<'a> !RefUnwindSafe for AgentRuntime<'a>

§

impl<'a> Send for AgentRuntime<'a>

§

impl<'a> Sync for AgentRuntime<'a>

§

impl<'a> Unpin for AgentRuntime<'a>

§

impl<'a> !UnwindSafe for AgentRuntime<'a>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more