Struct ic_utils::canister::SyncCallBuilder

pub struct SyncCallBuilder<'agent, 'canister: 'agent, T> { /* fields omitted */ }

A builder for a synchronous call (ie. query) to the Internet Computer.

See SyncCaller for a description of this structure once built.

Implementations

impl<'agent, 'canister: 'agent, Interface> SyncCallBuilder<'agent, 'canister, Interface>

pub fn with_arg<Argument>(
    self,
    arg: Argument
) -> SyncCallBuilder<'agent, 'canister, Interface> where
    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_value_arg(
    self,
    arg: IDLValue
) -> SyncCallBuilder<'agent, 'canister, Interface>

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. TODO: make this method unnecessary https://github.com/dfinity/agent-rs/issues/132

pub fn with_arg_raw(
    self,
    arg: Vec<u8>
) -> SyncCallBuilder<'agent, 'canister, Interface>

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 with_effective_canister_id(
    self,
    canister_id: Principal
) -> SyncCallBuilder<'agent, 'canister, Interface>

pub fn build<Output>(self) -> SyncCaller<'canister, Output> where
    Output: for<'de> ArgumentDecoder<'de> + Send + Sync, 

Builds an SyncCaller from this builder’s state.