Struct ic_agent::agent::UpdateBuilder
source · [−]pub struct UpdateBuilder<'agent> {
pub effective_canister_id: Principal,
pub canister_id: Principal,
pub method_name: String,
pub arg: Vec<u8>,
pub ingress_expiry_datetime: Option<u64>,
/* private fields */
}
Expand description
An Update Request Builder.
This makes it easier to do update calls without actually passing all arguments or specifying if you want to wait or not.
Fields
effective_canister_id: Principal
The effective canister ID of the destination.
canister_id: Principal
The principal ID of the canister being called.
method_name: String
The name of the canister method being called.
arg: Vec<u8>
The argument blob to be passed to the method.
ingress_expiry_datetime: Option<u64>
The Unix timestamp that the request will expire at.
Implementations
sourceimpl<'agent> UpdateBuilder<'agent>
impl<'agent> UpdateBuilder<'agent>
sourcepub fn new(
agent: &'agent Agent,
canister_id: Principal,
method_name: String
) -> Self
pub fn new(
agent: &'agent Agent,
canister_id: Principal,
method_name: String
) -> Self
Creates a new query builder with an agent for a particular canister method.
sourcepub fn with_effective_canister_id(
&mut self,
canister_id: Principal
) -> &mut Self
pub fn with_effective_canister_id(
&mut self,
canister_id: Principal
) -> &mut Self
Sets the effective canister ID of the destination.
sourcepub fn with_arg<A: AsRef<[u8]>>(&mut self, arg: A) -> &mut Self
pub fn with_arg<A: AsRef<[u8]>>(&mut self, arg: A) -> &mut Self
Sets the argument blob to pass to the canister. For most canisters this should be a Candid-serialized tuple.
sourcepub fn expire_at(&mut self, time: SystemTime) -> &mut Self
pub fn expire_at(&mut self, time: SystemTime) -> &mut Self
Takes a SystemTime converts it to a Duration by calling duration_since(UNIX_EPOCH) to learn about where in time this SystemTime lies. The Duration is converted to nanoseconds and stored in ingress_expiry_datetime
sourcepub fn expire_after(&mut self, duration: Duration) -> &mut Self
pub fn expire_after(&mut self, duration: Duration) -> &mut Self
Takes a Duration (i.e. 30 sec/5 min 30 sec/1 h 30 min, etc.) and adds it to the Duration of the current SystemTime since the UNIX_EPOCH Subtracts a permitted drift from the sum to account for using system time and not block time. Converts the difference to nanoseconds and stores in ingress_expiry_datetime
sourcepub async fn call_and_wait<W: Waiter>(
&self,
waiter: W
) -> Result<Vec<u8>, AgentError>
pub async fn call_and_wait<W: Waiter>(
&self,
waiter: W
) -> Result<Vec<u8>, AgentError>
Make an update call. This will call request_status on the RequestId in a loop and return the response as a byte vector.
sourcepub fn call(&self) -> UpdateCall<'_>ⓘNotable traits for UpdateCall<'_>impl Future for UpdateCall<'_> type Output = Result<RequestId, AgentError>;
pub fn call(&self) -> UpdateCall<'_>ⓘNotable traits for UpdateCall<'_>impl Future for UpdateCall<'_> type Output = Result<RequestId, AgentError>;
Make an update call. This will return a RequestId. The RequestId should then be used for request_status (most likely in a loop).
sourcepub fn sign(&self) -> Result<SignedUpdate, AgentError>
pub fn sign(&self) -> Result<SignedUpdate, AgentError>
Sign a update call. This will return a signed::SignedUpdate
which contains all fields of the update and the signed update in CBOR encoding
Trait Implementations
Auto Trait Implementations
impl<'agent> !RefUnwindSafe for UpdateBuilder<'agent>
impl<'agent> Send for UpdateBuilder<'agent>
impl<'agent> Sync for UpdateBuilder<'agent>
impl<'agent> Unpin for UpdateBuilder<'agent>
impl<'agent> !UnwindSafe for UpdateBuilder<'agent>
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