Struct ic_utils::call::AsyncCaller
source · pub struct AsyncCaller<'agent, Out>where
Out: for<'de> ArgumentDecoder<'de> + Send,{ /* private fields */ }
Expand description
An async caller, encapsulating a call to an update method.
Implementations§
source§impl<'agent, Out> AsyncCaller<'agent, Out>where
Out: for<'de> ArgumentDecoder<'de> + Send,
impl<'agent, Out> AsyncCaller<'agent, Out>where
Out: for<'de> ArgumentDecoder<'de> + Send,
sourcepub fn build_call(self) -> Result<UpdateBuilder<'agent>, AgentError>
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.
sourcepub async fn call(self) -> Result<RequestId, AgentError>
pub async fn call(self) -> Result<RequestId, AgentError>
See AsyncCall::call
.
sourcepub async fn call_and_wait(self) -> Result<Out, AgentError>
pub async fn call_and_wait(self) -> Result<Out, AgentError>
sourcepub async fn call_and_wait_one<T>(self) -> Result<T, AgentError>where
T: DeserializeOwned + CandidType,
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,)
.
sourcepub fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map>
pub fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map>
See AsyncCall::map
.
Trait Implementations§
source§impl<'agent, Out> AsyncCall<Out> for AsyncCaller<'agent, Out>where
Out: for<'de> ArgumentDecoder<'de> + Send,
impl<'agent, Out> AsyncCall<Out> for AsyncCaller<'agent, Out>where
Out: for<'de> ArgumentDecoder<'de> + Send,
source§fn call<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Result<RequestId, AgentError>> + Send + 'async_trait>>where
Self: 'async_trait,
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. Read more
source§fn call_and_wait<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Result<Out, AgentError>> + Send + 'async_trait>>where
Self: 'async_trait,
fn call_and_wait<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Result<Out, AgentError>> + Send + '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.
source§fn and_then<Out2, R, AndThen>(
self,
and_then: AndThen
) -> AndThenAsyncCaller<Out, Out2, Self, R, AndThen>where
Self: Sized + Send,
Out2: for<'de> ArgumentDecoder<'de> + Send,
R: Future<Output = Result<Out2, AgentError>> + Send,
AndThen: Send + Fn(Out) -> R,
fn and_then<Out2, R, AndThen>(
self,
and_then: AndThen
) -> AndThenAsyncCaller<Out, Out2, Self, R, AndThen>where
Self: Sized + Send,
Out2: for<'de> ArgumentDecoder<'de> + Send,
R: Future<Output = Result<Out2, AgentError>> + Send,
AndThen: Send + Fn(Out) -> R,
Apply a transformation function after the call has been successful. The transformation
is applied with the result. Read more
source§fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map>
fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map>
Apply a transformation function after the call has been successful. Equivalent to
.and_then(|x| async { map(x) })
.Auto Trait Implementations§
impl<'agent, Out> Freeze for AsyncCaller<'agent, Out>
impl<'agent, Out> !RefUnwindSafe for AsyncCaller<'agent, Out>
impl<'agent, Out> Send for AsyncCaller<'agent, Out>
impl<'agent, Out> Sync for AsyncCaller<'agent, Out>where
Out: Sync,
impl<'agent, Out> Unpin for AsyncCaller<'agent, Out>where
Out: Unpin,
impl<'agent, Out> !UnwindSafe for AsyncCaller<'agent, Out>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more