Struct ic_utils::canister::SyncCallBuilder
source · [−]pub struct SyncCallBuilder<'agent, 'canister: 'agent, T> { /* private fields */ }Expand description
A builder for a synchronous call (ie. query) to the Internet Computer.
See SyncCaller for a description of this structure once built.
Implementations
sourceimpl<'agent, 'canister: 'agent, Interface> SyncCallBuilder<'agent, 'canister, Interface>
impl<'agent, 'canister: 'agent, Interface> SyncCallBuilder<'agent, 'canister, Interface>
sourcepub fn with_arg<Argument>(
self,
arg: Argument
) -> SyncCallBuilder<'agent, 'canister, Interface> where
Argument: CandidType + Sync + Send,
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.
sourcepub fn with_value_arg(
self,
arg: IDLValue
) -> SyncCallBuilder<'agent, 'canister, Interface>
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
sourcepub fn with_arg_raw(
self,
arg: Vec<u8>
) -> SyncCallBuilder<'agent, 'canister, Interface>
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.
sourcepub fn with_effective_canister_id(
self,
canister_id: Principal
) -> SyncCallBuilder<'agent, 'canister, Interface>
pub fn with_effective_canister_id(
self,
canister_id: Principal
) -> SyncCallBuilder<'agent, 'canister, Interface>
Sets the effective canister ID of the destination.
sourcepub fn build<Output>(self) -> SyncCaller<'canister, Output> where
Output: for<'de> ArgumentDecoder<'de> + Send + Sync,
pub fn build<Output>(self) -> SyncCaller<'canister, Output> where
Output: for<'de> ArgumentDecoder<'de> + Send + Sync,
Builds an SyncCaller from this builder’s state.
Trait Implementations
Auto Trait Implementations
impl<'agent, 'canister, T> !RefUnwindSafe for SyncCallBuilder<'agent, 'canister, T>
impl<'agent, 'canister, T> Send for SyncCallBuilder<'agent, 'canister, T> where
T: Sync,
impl<'agent, 'canister, T> Sync for SyncCallBuilder<'agent, 'canister, T> where
T: Sync,
impl<'agent, 'canister, T> Unpin for SyncCallBuilder<'agent, 'canister, T> where
'agent: 'canister,
impl<'agent, 'canister, T> !UnwindSafe for SyncCallBuilder<'agent, 'canister, T>
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