Struct FinalizedBlocksStream 

pub struct FinalizedBlocksStream { /* private fields */ }

A stream of finalized blocks. This contains a background task that polls for new finalized blocks indefinitely. The task can be stopped by dropping the object.

Implementations

impl FinalizedBlocksStream

pub async fn next(&mut self) -> Option<FinalizedBlockInfo>

Retrieves the next finalized block from the stream. This function will block until a finalized block becomes available. To avoid waiting indefinitely, consider using FinalizedBlocksStream::next_timeout instead. If the channel is closed, the next element is None.

pub async fn next_timeout( &mut self, duration: Duration, ) -> Result<Option<FinalizedBlockInfo>, Elapsed>

Similar to FinalizedBlocksStream::next, but with a maximum wait time defined by the specified duration between each finalized block.

pub async fn next_chunk( &mut self, n: usize, ) -> Result<Vec<FinalizedBlockInfo>, Vec<FinalizedBlockInfo>>

Get the next chunk of blocks. If the finalized block poller has been disconnected this will return Err(blocks) where blocks are the finalized blocks that were retrieved before closure. In that case all further calls will return Err(Vec::new()).

In case of success up to max(1, n) elements will be returned. This function will block so it always returns at least one element, and will retrieve up to n elements without blocking further once at least one element has been acquired.

pub async fn next_chunk_timeout( &mut self, n: usize, duration: Duration, ) -> Result<(bool, Vec<FinalizedBlockInfo>), Elapsed>

Like next_chunk, but waits no more than the given duration for the block. The boolean signifies whether an error occurred (it is true if an error occurred) while getting blocks. If that is the case further calls will always yield an error.

The first field of the response indicates if an error occurred. This will only happen if the stream of finalized blocks has unexpectedly dropped.

Trait Implementations

impl Drop for FinalizedBlocksStream

fn drop(&mut self)

Executes the destructor for this type.