Struct CallForwarder 

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

An interface for forwarding a canister method call through the wallet canister via wallet_canister_call.

Implementations

impl<'agent: 'canister, 'canister, Out> CallForwarder<'agent, 'canister, Out>

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

pub fn with_arg<Argument>(self, arg: Argument) -> Self

where Argument: CandidType + Sync + Send,

Set the argument with candid argument. Can be called at most once.

pub fn with_args(self, tuple: impl ArgumentEncoder) -> Self

Set the argument with multiple arguments as tuple. Can be called at most once.

pub fn with_arg_raw(self, arg: Vec<u8>) -> Self

Set the argument with raw argument bytes. Can be called at most once.

pub fn build(self) -> Result<impl 'agent + AsyncCall<Value = Out>, AgentError>

Creates an AsyncCall implementation that, when called, will forward the specified canister call.

pub fn call( self, ) -> impl Future<Output = Result<CallResponse<Out>, AgentError>> + 'agent

Calls the forwarded canister call on the wallet canister. Equivalent to .build().call().

pub fn call_and_wait( self, ) -> impl Future<Output = Result<Out, AgentError>> + 'agent

Calls the forwarded canister call on the wallet canister, and waits for the result. Equivalent to .build().call_and_wait().

Trait Implementations

impl<'agent: 'canister, 'canister, Out> AsyncCall for CallForwarder<'agent, 'canister, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + Sync + '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, 'canister, Out> Debug for CallForwarder<'agent, 'canister, Out>

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

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

Formats the value using the given formatter.

impl<'agent: 'canister, 'canister, Out> IntoFuture for CallForwarder<'agent, 'canister, Out>

where Out: for<'de> ArgumentDecoder<'de> + Send + Sync + '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.