Struct ic_utils::call::AsyncCaller

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

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

Implementations

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

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

Perform this call and returns .

pub async fn call_and_wait<W>(self, waiter: W) -> Result<Out, AgentError> where
    W: Waiter, 

pub async fn call_and_wait_one<W, T>(self, waiter: W) -> Result<T, AgentError> where
    W: Waiter,
    T: DeserializeOwned, 

pub fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map> where
    Out2: for<'de> ArgumentDecoder<'de> + Send + Sync,
    Map: Sync + Send + Fn(Out) -> Out2, 

Trait Implementations

impl<'agent, Out> AsyncCall<Out> for AsyncCaller<'agent, Out> where
    Out: for<'de> ArgumentDecoder<'de> + Send + Sync, 

fn call<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<RequestId, AgentError>> + Send + '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, W>(
    self,
    waiter: W
) -> Pin<Box<dyn Future<Output = Result<Out, AgentError>> + Send + 'async_trait>> where
    W: Waiter,
    W: 'async_trait,
    Self: 'async_trait, 

Execute the call, and wait for an answer using a Waiter strategy. The return type is encoded in the trait.

fn and_then<Out2, R, AndThen>(
    self,
    and_then: AndThen
) -> AndThenAsyncCaller<Out, Out2, Self, R, AndThen> where
    Self: Sized + Sync + Send,
    Out2: for<'de> ArgumentDecoder<'de> + Send + Sync,
    R: Future<Output = Result<Out2, AgentError>> + Send + Sync,
    AndThen: Sync + Send + Fn(Out) -> R, 

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

fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map> where
    Self: Sized + Sync + Send,
    Out2: for<'de> ArgumentDecoder<'de> + Send + Sync,
    Map: Sync + Send + Fn(Out) -> Out2,