Struct hedera::MirrorQuery

pub struct MirrorQuery<D> { /* private fields */ }

A query that can be executed on the Hedera mirror network.

Implementations

impl<D> MirrorQuery<D>

where D: MirrorQueryExecute,

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.

Note that timeout is the connection timeout.

pub fn subscribe<'a>(&self, client: &'a Client) -> D::ItemStream<'a>

Subscribe to this query with the provided client of the Hedera network.

pub fn subscribe_with_timeout<'a>( &self, client: &'a Client, timeout: Duration ) -> D::ItemStream<'a>

Subscribe to this query with the provided client of the Hedera network.

Note that timeout is the connection timeout.

impl<D> MirrorQuery<D>

where D: MirrorQueryExecute + Default,

pub fn new() -> Self

Create a new query ready for configuration and execution.

impl MirrorQuery<NodeAddressBookQueryData>

pub fn get_file_id(&self) -> FileId

Returns the file ID of the address book file on the network.

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

Sets the ID of the address book file on the network. Can either be 0.0.101 or 0.0.102. Defaults to 0.0.102.

pub fn get_limit(&self) -> u32

Returns the configured limit of node addresses to receive.

pub fn limit(&mut self, limit: u32) -> &mut Self

Sets the maximum number of node addresses to receive. Defaults to all.

impl MirrorQuery<TopicMessageQueryData>

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

Returns the ID of the topic to retrieve messages for.

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

Sets the topic ID to retrieve messages for.

pub fn get_start_time(&self) -> Option<OffsetDateTime>

Returns the minimum consensus_timestamp of the messages to return.

pub fn start_time(&mut self, time: OffsetDateTime) -> &mut Self

Sets to include messages which reached consensus on or after this time. Defaults to the current time.

pub fn get_end_time(&self) -> Option<OffsetDateTime>

Returns the maximum consensus_timestamp of the messages to return.

pub fn end_time(&mut self, time: OffsetDateTime) -> &mut Self

Sets to include messages which reached consensus before this time.

pub fn get_limit(&self) -> u64

Returns maximum number of messages to be returned.

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

Sets the maximum number of messages to be returned, before closing the subscription. Defaults to unlimited.

Trait Implementations

impl<D: Clone> Clone for MirrorQuery<D>

fn clone(&self) -> MirrorQuery<D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug> Debug for MirrorQuery<D>

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

Formats the value using the given formatter.

impl<D: Default> Default for MirrorQuery<D>

fn default() -> MirrorQuery<D>

Returns the “default value” for a type.