Struct UpdateBuilder

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 */
}

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

impl<'agent> UpdateBuilder<'agent>

pub fn new( agent: &'agent Agent, canister_id: Principal, method_name: String, ) -> Self

Creates a new update builder with an agent for a particular canister method.

pub fn with_effective_canister_id(self, canister_id: Principal) -> Self

Sets the effective canister ID of the destination.

pub fn with_arg<A: Into<Vec<u8>>>(self, arg: A) -> Self

Sets the argument blob to pass to the canister. For most canisters this should be a Candid-serialized tuple.

pub fn expire_at(self, time: impl Into<OffsetDateTime>) -> Self

Sets ingress_expiry_datetime to the provided timestamp, at nanosecond precision.

pub fn expire_after(self, duration: Duration) -> Self

Sets ingress_expiry_datetime to min(now, 4min).

pub async fn call_and_wait(self) -> 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.

pub fn call(self) -> UpdateCall<'agent>

Make an update call. This will return a RequestId. The RequestId should then be used for request_status (most likely in a loop).

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

impl<'agent> Debug for UpdateBuilder<'agent>

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

Formats the value using the given formatter.

impl<'agent> IntoFuture for UpdateBuilder<'agent>

type IntoFuture = Pin<Box<dyn Future<Output = Result<Vec<u8>, AgentError>> + Send + 'agent>>

Which kind of future are we turning this into?

type Output = Result<Vec<u8>, AgentError>

The output that the future will produce on completion.

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.