Struct BlockEventsSub 

pub struct BlockEventsSub { /* private fields */ }

Subscription wrapper that streams BlockPhaseEvent lists.

Implementations

impl BlockEventsSub

pub fn new(client: Client, opts: EventOpts) -> Self

Creates a subscription that yields event batches filtered by the supplied options. No network calls are made until BlockEventsSub::next is awaited.

pub async fn next(&mut self) -> Result<BlockEventsSubValue, Error>

Fetches the next block with events matching the configured filters.

This function automatically skips blocks with empty event lists and continues searching until a block with events is found. For direct access to all blocks (including those with empty events), use BlockEventsSub::next_step.

Returns

• Ok(BlockEventsSubValue) when a block with events matching the configured filters is found.
• Err(crate::Error) when the RPC request fails; the internal cursor rewinds so the block can be retried.

Behavior

• Blocks with empty event lists are automatically skipped
• The function will continue to the next block until events are found
• On RPC failure, the cursor is rewound to allow retrying the same block

Errors

Returns Err(crate::Error) when the underlying RPC request fails.

pub async fn next_step(&mut self) -> Result<BlockEventsSubValue, Error>

Fetches the next block’s events without filtering empty results.

This is a lower-level function that returns events for the next block regardless of whether the event list is empty. Use BlockEventsSub::next for automatic filtering of empty event lists.

Returns

• Ok(BlockEventsSubValue) containing the block’s events, height, and hash.
• Err(crate::Error) when the RPC request fails; the internal cursor rewinds so the block can be retried.

Errors

Returns Err(crate::Error) when the underlying RPC request to fetch block events fails.

pub fn set_options(&mut self, value: EventOpts)

Replaces the filter options applied to subsequent next calls.

Arguments

• value - New event filtering options supplied to the RPC query.

pub fn should_retry_on_error(&self) -> bool

Reports whether failed RPC calls will be retried.

pub fn use_best_block(&mut self, value: bool)

Follow best blocks instead of finalized ones.

pub fn set_block_height(&mut self, block_height: u32)

Jump the cursor to a specific starting height.

pub fn set_pool_rate(&mut self, value: Duration)

Change how often the subscription polls for new blocks when following the head.

pub fn set_retry_on_error(&mut self, value: Option<bool>)

Override the retry behaviour (Some(true) = force, Some(false) = disable).

Trait Implementations

impl Clone for BlockEventsSub

fn clone(&self) -> BlockEventsSub

Returns a duplicate of the value.

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

Performs copy-assignment from source.