Struct gclient::EventListener

pub struct EventListener(/* private fields */);

Event listener that allows catching and processing events propagated through the network.

Examples

use gclient::GearApi;

#[tokio::test]
async fn listener_test() -> Result<()> {
    let api = GearApi::dev().await?;
    let mut listener = api.subscribe().await?;
    assert!(listener.blocks_running().await?);
    Ok(())
}

Implementations

impl EventListener

pub async fn queue_processing_reverted(&mut self) -> Result<H256>

Look through finalized blocks to find the QueueNotProcessed event.

pub async fn next_block_hash(&mut self) -> Result<H256>

Reads the next event from the stream and returns the respective block hash.

pub async fn blocks_running_since(&mut self, previous: H256) -> Result<bool>

Check whether at least one new block has been produced after the previous block.

pub async fn blocks_running(&mut self) -> Result<bool>

Check whether new blocks are produced as expected.

Trait Implementations

impl EventProcessor for EventListener

fn not_waited() -> Error

This function is called if a received event has an unexpected type.

fn proc<'life0, 'async_trait, T>( &'life0 mut self, predicate: impl 'async_trait + Fn(Event) -> Option<T> + Copy, ) -> Pin<Box<dyn Future<Output = Result<T>> + 'async_trait>>

where T: 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Event processing function.

fn proc_many<'life0, 'async_trait, T>( &'life0 mut self, predicate: impl 'async_trait + Fn(Event) -> Option<T>, validate: impl 'async_trait + Fn(Vec<T>) -> (Vec<T>, bool), ) -> Pin<Box<dyn Future<Output = Result<Vec<T>>> + 'async_trait>>

where T: 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Multiple events processing function.

fn message_processed<'life0, 'async_trait>( &'life0 mut self, message_id: MessageId, ) -> Pin<Box<dyn Future<Output = Result<DispatchStatus>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check whether the message identified by message_id has been processed.

fn message_processed_batch<'life0, 'async_trait>( &'life0 mut self, message_ids: impl 'async_trait + IntoIterator<Item = MessageId>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, DispatchStatus)>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check whether the batch of messages identified by corresponding message_ids has been processed.

fn reply_bytes_on<'life0, 'async_trait>( &'life0 mut self, message_id: MessageId, ) -> Pin<Box<dyn Future<Output = Result<(MessageId, Result<Vec<u8>, String>, u128)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get details of a reply to the message identified by message_id.

fn err_or_succeed<'life0, 'async_trait>( &'life0 mut self, message_id: MessageId, ) -> Pin<Box<dyn Future<Output = Result<Option<String>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check whether the processing of a message identified by message_id resulted in an error or has been successful.

fn err_or_succeed_batch<'life0, 'async_trait>( &'life0 mut self, message_ids: impl 'async_trait + IntoIterator<Item = MessageId>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, Option<String>)>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check whether processing batch of messages identified by corresponding message_ids resulted in errors or has been successful.