Struct hedera::Query

pub struct Query<D>
where
    D: QueryExecute,
{ /* private fields */ }

A query that can be executed on the Hedera network.

Implementations

impl Query<AccountBalanceQueryData>

pub fn get_account_id(&self) -> Option<AccountId>

Get the account ID for which information is requested.

pub fn account_id(&mut self, id: AccountId) -> &mut Self

Sets the account ID for which information is requested.

This is mutually exclusive with contract_id.

pub fn get_contract_id(&self) -> Option<ContractId>

Get the contract ID for which information is requested.

pub fn contract_id(&mut self, id: ContractId) -> &mut Self

Sets the contract ID for which information is requested.

This is mutually exclusive with account_id.

impl Query<AccountInfoQueryData>

pub fn get_account_id(&self) -> Option<AccountId>

Gets the account ID for which information is requested.

pub fn account_id(&mut self, id: AccountId) -> &mut Self

Sets the account ID for which information is requested.

impl Query<AccountRecordsQueryData>

pub fn get_account_id(&self) -> Option<AccountId>

Gets the account ID for which the records should be retrieved.

pub fn account_id(&mut self, id: AccountId) -> &mut Self

Sets the account ID for which the records should be retrieved.

impl Query<AccountStakersQueryData>

pub fn get_account_id(&self) -> Option<AccountId>

Gets the account ID for which the records should be retrieved.

pub fn account_id(&mut self, id: AccountId) -> &mut Self

Sets the account ID for which the records should be retrieved.

impl Query<ContractBytecodeQueryData>

pub fn get_contract_id(&self) -> Option<ContractId>

Gets the contract for which information is requested.

pub fn contract_id(&mut self, contract_id: ContractId) -> &mut Self

Sets the contract for which information is requested.

impl Query<ContractCallQueryData>

pub fn get_contract_id(&self) -> Option<ContractId>

Gets the contract instance to call.

pub fn contract_id(&mut self, contract_id: ContractId) -> &mut Self

Sets the contract to make a static call against.

pub fn get_gas(&self) -> u64

Gets the amount of gas to use for the call.

pub fn gas(&mut self, gas: u64) -> &mut Self

Sets the amount of gas to use for the call.

pub fn get_contract_parameters(&self) -> &[u8]

Gets the function parameters as their raw bytes.

pub fn function_parameters(&mut self, data: Vec<u8>) -> &mut Self

Sets the function parameters as their raw bytes.

pub fn function(&mut self, name: &str) -> &mut Self

Sets the function with no parameters.

pub fn function_with_parameters( &mut self, name: &str, parameters: &ContractFunctionParameters ) -> &mut Self

Sets the function with parameters.

pub fn get_sender_account_id(&self) -> Option<AccountId>

Gets the sender for this transaction.

pub fn sender_account_id(&mut self, sender_account_id: AccountId) -> &mut Self

Sets the sender for this transaction.

impl Query<ContractInfoQueryData>

pub fn get_contract_id(&self) -> Option<ContractId>

Returns the contract for which information is requested.

pub fn contract_id(&mut self, contract_id: ContractId) -> &mut Self

Sets the contract for which information is requested.

impl Query<FileContentsQueryData>

pub fn get_file_id(&self) -> Option<FileId>

Returns the ID of the file for which contents are requested.

pub fn file_id(&mut self, id: impl Into<FileId>) -> &mut Self

Sets the file ID for which contents are requested.

impl Query<FileInfoQueryData>

pub fn get_file_id(&self) -> Option<FileId>

Returns the ID of the file for which information is requested.

pub fn file_id(&mut self, id: impl Into<FileId>) -> &mut Self

Sets the ID of the file for which information is requested.

impl<D> Query<D>

where D: QueryExecute + Default,

pub fn new() -> Self

Create a new query ready for configuration and execution.

impl<D> Query<D>

where D: QueryExecute,

pub fn get_node_account_ids(&self) -> Option<&[AccountId]>

Returns the account IDs of the nodes that this query may be submitted to.

Defaults to the full list of nodes configured on the client; or, the node account IDs configured on the query payment transaction (if explicitly provided).

pub fn node_account_ids( &mut self, ids: impl IntoIterator<Item = AccountId> ) -> &mut Self

Sets the account IDs of the nodes that this query may be submitted to.

Defaults to the full list of nodes configured on the client; or, the node account IDs configured on the query payment transaction (if explicitly provided).

pub fn get_payment_amount(&self) -> Option<Hbar>

Returns the explicit payment amount for this query.

The client will submit exactly this amount for the payment of this query. Hedera will not return any remainder (over the actual cost for this query).

pub fn payment_amount(&mut self, amount: Hbar) -> &mut Self

Sets the explicit payment amount for this query.

The client will submit exactly this amount for the payment of this query. Hedera will not return any remainder (over the actual cost for this query).

pub fn get_max_amount(&self) -> Option<Hbar>

Returns the maximum payment allowable for this query.

pub fn max_payment_amount(&mut self, max: impl Into<Option<Hbar>>) -> &mut Self

Sets the maximum payment allowable for this query.

When a query is executed without an explicit payment amount set, the client will first request the cost of the given query from the node it will be submitted to and attach a payment for that amount from the operator account on the client.

If the returned value is greater than this value, a MaxQueryPaymentExceeded error will be returned.

Defaults to the maximum payment amount configured on the client.

Sets to None to allow unlimited payment amounts.

pub fn get_payment_transaction_valid_duration(&self) -> Option<Duration>

Returns the duration that the payment transaction is valid for, once finalized and signed.

pub fn payment_transaction_valid_duration( &mut self, duration: Duration ) -> &mut Self

Sets the duration that the payment transaction is valid for, once finalized and signed.

Defaults to 120 seconds (or two minutes).

pub fn get_max_payment_transaction_fee(&self) -> Option<Hbar>

Returns the maximum transaction fee the payer account is willing to pay for the query payment transaction.

pub fn max_payment_transaction_fee(&mut self, fee: Hbar) -> &mut Self

Sets the maximum transaction fee the payer account is willing to pay for the query payment transaction.

Defaults to 1 hbar.

pub fn get_payment_transaction_memo(&self) -> &str

Returns the note / description that should be recorded in the transaction record for the payment transaction.

pub fn payment_transaction_memo(&mut self, memo: impl AsRef<str>) -> &mut Self

Sets a note / description that should be recorded in the transaction record for the payment transaction.

Maximum length of 100 characters.

pub fn get_payment_transaction_id(&self) -> Option<TransactionId>

Returns the explicit transaction ID used to identify this query’s payment transaction, if set .

pub fn payment_transaction_id(&mut self, id: TransactionId) -> &mut Self

Sets an explicit transaction ID to use to identify the payment transaction on this query.

Overrides payer account defined on this query or on the client.

pub async fn get_cost(&self, client: &Client) -> Result<Hbar>

Fetch the cost of this query.

pub async fn get_cost_with_timeout( &self, client: &Client, timeout: Duration ) -> Result<Hbar>

Fetch the cost of this query.

impl<D> Query<D>

where D: QueryExecute,

pub async fn execute(&mut self, client: &Client) -> Result<D::Response>

Execute this query against the provided client of the Hedera network.

pub async fn execute_with_timeout( &mut self, client: &Client, timeout: Duration ) -> Result<D::Response>

Execute this query against the provided client of the Hedera network.

impl Query<ScheduleInfoQueryData>

pub fn get_schedule_id(&self) -> Option<ScheduleId>

Returns the schedule ID for which information is requested.

pub fn schedule_id(&mut self, id: impl Into<ScheduleId>) -> &mut Self

Sets the schedule ID for which information is requested.

impl Query<TokenInfoQueryData>

pub fn get_token_id(&self) -> Option<TokenId>

Returns the token ID for which information is requested.

pub fn token_id(&mut self, id: impl Into<TokenId>) -> &mut Self

Sets the token ID for which information is requested.

impl Query<TokenNftInfoQueryData>

pub fn get_nft_id(&self) -> Option<NftId>

Returns the ID of the NFT for which information is requested.

pub fn nft_id(&mut self, nft_id: impl Into<NftId>) -> &mut Self

Sets the ID of the NFT for which information is requested.

impl Query<TopicInfoQueryData>

pub fn get_topic_id(&self) -> Option<TopicId>

Returns the topic to retrieve info about.

pub fn topic_id(&mut self, id: impl Into<TopicId>) -> &mut Self

Sets the topic to retrieve info about.

impl Query<TransactionReceiptQueryData>

pub fn get_transaction_id(&self) -> Option<TransactionId>

Get the ID of the transaction for which the receipt is being requested.

pub fn transaction_id(&mut self, transaction_id: TransactionId) -> &mut Self

Sets the ID of the transaction for which the receipt is being requested.

pub fn get_include_children(&self) -> bool

Whether the response should include the receipts of any child transactions spawned by the top-level transaction with the given transaction.

pub fn include_children(&mut self, include: bool) -> &mut Self

Whether the response should include the receipts of any child transactions spawned by the top-level transaction with the given transaction.

pub fn get_include_duplicates(&self) -> bool

Whether receipts of processing duplicate transactions should be returned.

pub fn include_duplicates(&mut self, include: bool) -> &mut Self

Whether receipts of processing duplicate transactions should be returned.

pub fn get_validate_status(&self) -> bool

Whether the receipt status should be validated.

pub fn validate_status(&mut self, validate: bool) -> &mut Self

Whether the receipt status should be validated.

impl Query<TransactionRecordQueryData>

pub fn get_transaction_id(&self) -> Option<TransactionId>

Get the ID of the transaction for which the record is being requested.

pub fn transaction_id(&mut self, transaction_id: TransactionId) -> &mut Self

Sets the ID of the transaction for which the record is being requested.

pub fn get_include_children(&self) -> bool

Whether the response should include the records of any child transactions spawned by the top-level transaction with the given transaction.

pub fn include_children(&mut self, include: bool) -> &mut Self

Whether the response should include the records of any child transactions spawned by the top-level transaction with the given transaction.

pub fn get_include_duplicates(&self) -> bool

Whether records of processing duplicate transactions should be returned.

pub fn include_duplicates(&mut self, include: bool) -> &mut Self

Whether records of processing duplicate transactions should be returned.

pub fn get_validate_status(&self) -> bool

Whether records of processing duplicate transactions should be returned.

pub fn validate_status(&mut self, validate: bool) -> &mut Self

Whether the record status should be validated.

Trait Implementations

impl<D> Debug for Query<D>

where D: QueryExecute + Debug,

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

Formats the value using the given formatter.

impl<D> Default for Query<D>

where D: QueryExecute + Default,

fn default() -> Query<D>

Returns the “default value” for a type.