Struct ic_agent::agent::QueryBuilder
source · pub struct QueryBuilder<'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
A Query Request Builder.
This makes it easier to do query calls without actually passing all arguments.
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§
source§impl<'agent> QueryBuilder<'agent>
impl<'agent> QueryBuilder<'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(&self) -> Result<Vec<u8>, AgentError>
pub async fn call(&self) -> Result<Vec<u8>, AgentError>
Make a query call. This will return a byte vector.
sourcepub fn sign(&self) -> Result<SignedQuery, AgentError>
pub fn sign(&self) -> Result<SignedQuery, AgentError>
Sign a query call. This will return a signed::SignedQuery
which contains all fields of the query and the signed query in CBOR encoding