Struct ic_utils::interfaces::wallet::CallForwarder

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

pub fn with_arg<Argument>(self, arg: Argument) -> Selfwhere
    Argument: CandidType + Sync + Send,

Add an argument to the candid argument list. This requires Candid arguments, if there is a raw argument set (using [with_arg_raw]), this will fail.

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

Replace the argument with raw argument bytes. This will overwrite the current argument set, so calling this method twice will discard the first argument.

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

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<W>(self, waiter: W) -> Result<Out, AgentError>where
    W: Waiter,

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

Trait Implementations

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

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

Formats the value using the given formatter.