Struct ChangeEventResultStream 

pub struct ChangeEventResultStream { /* private fields */ }

Async stream that also yields lag errors.

Implements Stream<Item = Result<ChangeEvent, PushSubscriptionError>>, allowing explicit handling of lag and error conditions. Use this when you need to react to missed events rather than silently skipping them.

Usage

use tokio_stream::StreamExt;

let mut stream = subscribe_stream_with_errors(registry, "trades".into(), 0, config);

while let Some(result) = stream.next().await {
    match result {
        Ok(event) => process(event),
        Err(PushSubscriptionError::Lagged(n)) => {
            eprintln!("Missed {n} events");
        }
        Err(e) => break,
    }
}

Implementations

impl ChangeEventResultStream

pub fn id(&self) -> SubscriptionId

Returns the subscription ID.

pub fn is_terminated(&self) -> bool

Returns true if the stream has terminated.

pub fn cancel(&mut self)

Cancels the subscription and terminates the stream.

Trait Implementations

impl Drop for ChangeEventResultStream

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for ChangeEventResultStream

type Item = Result<ChangeEvent, PushSubscriptionError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.