Struct AsyncCaller 

pub struct AsyncCaller<'agent, Out>
where
    Out: for<'de> ArgumentDecoder<'de> + Send,
{ /* private fields */ }

An async caller, encapsulating a call to an update method.

Implementations

impl<'agent, Out> AsyncCaller<'agent, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + 'agent,

pub fn build_call(self) -> Result<UpdateBuilder<'agent>, AgentError>

Build an UpdateBuilder call that can be used directly with the Agent. This is essentially downleveling this type into the lower level [ic-agent] abstraction.

pub async fn call(self) -> Result<CallResponse<Out>, AgentError>

See AsyncCall::call.

pub async fn call_and_wait(self) -> Result<Out, AgentError>

See AsyncCall::call_and_wait.

pub async fn call_and_wait_one<T>(self) -> Result<T, AgentError>

where T: DeserializeOwned + CandidType,

Equivalent to calling AsyncCall::call_and_wait with the expected return type (T,).

pub fn map<Out2, Map>( self, map: Map, ) -> MappedAsyncCaller<'agent, Out, Out2, Self, Map>

where Out2: for<'de> ArgumentDecoder<'de> + Send, Map: Send + Fn(Out) -> Out2,

See AsyncCall::map.

Trait Implementations

impl<'agent, Out> AsyncCall for AsyncCaller<'agent, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + 'agent,

type Value = Out

The return type of the Candid function being called.

fn call<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<CallResponse<Out>, AgentError>> + 'async_trait>>

where Self: 'async_trait,

Execute the call, but returns the RequestId. Waiting on the request Id must be managed by the caller using the Agent directly.

fn call_and_wait<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<Out, AgentError>> + 'async_trait>>

where Self: 'async_trait,

Execute the call, and wait for an answer using an exponential-backoff strategy. The return type is encoded in the trait.

fn and_then<'a, Out2, R, AndThen>( self, and_then: AndThen, ) -> AndThenAsyncCaller<'a, Self::Value, Out2, Self, R, AndThen>

where Self: Sized + Send + 'a, Out2: for<'de> ArgumentDecoder<'de> + Send + 'a, R: Future<Output = Result<Out2, AgentError>> + Send + 'a, AndThen: Send + Fn(Self::Value) -> R + 'a,

Apply a transformation function after the call has been successful. The transformation is applied with the result.

fn map<'a, Out, Map>( self, map: Map, ) -> MappedAsyncCaller<'a, Self::Value, Out, Self, Map>

where Self: Sized + Send + 'a, Out: for<'de> ArgumentDecoder<'de> + Send + 'a, Map: Send + Fn(Self::Value) -> Out + 'a,

Apply a transformation function after the call has been successful. Equivalent to .and_then(|x| async { map(x) }).

impl<'agent, Out> Debug for AsyncCaller<'agent, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + Debug,

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

Formats the value using the given formatter.

impl<'agent, Out> IntoFuture for AsyncCaller<'agent, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + 'agent,

type IntoFuture = Pin<Box<dyn Future<Output = Result<Out, AgentError>> + 'agent>>

Which kind of future are we turning this into?

type Output = Result<Out, AgentError>

The output that the future will produce on completion.

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.