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
sourceimpl<'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<W>(self, waiter: W) -> Result<Out, AgentError> where
W: Waiter,
pub async fn call_and_wait<W>(self, waiter: W) -> Result<Out, AgentError> where
W: Waiter,
sourcepub async fn call_and_wait_one<W, T>(self, waiter: W) -> Result<T, AgentError> where
W: Waiter,
T: DeserializeOwned + CandidType,
pub async fn call_and_wait_one<W, T>(self, waiter: W) -> Result<T, AgentError> where
W: Waiter,
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> where
Out2: for<'de> ArgumentDecoder<'de> + Send,
Map: Send + Fn(Out) -> Out2,
pub fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map> where
Out2: for<'de> ArgumentDecoder<'de> + Send,
Map: Send + Fn(Out) -> Out2,
See AsyncCall::map
.
Trait Implementations
sourceimpl<'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,
sourcefn 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
sourcefn 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,
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,
sourcefn 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
sourcefn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map> where
Self: Sized + Send,
Out2: for<'de> ArgumentDecoder<'de> + Send,
Map: Send + Fn(Out) -> Out2,
fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map> where
Self: Sized + Send,
Out2: for<'de> ArgumentDecoder<'de> + Send,
Map: Send + Fn(Out) -> Out2,
Apply a transformation function after the call has been successful. Equivalent to .and_then(|x| async { map(x) })
.
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more