Struct ic_utils::interfaces::wallet::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,

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<'out>(self) -> Result<impl 'out + AsyncCall<Out>, AgentError>

where Out: 'out, 'agent: 'out,

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

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

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

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

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<Out> for CallForwarder<'agent, 'canister, 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>( 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.

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.

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) }).

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.