Struct LiveEventStream 

pub struct LiveEventStream { /* private fields */ }

A [futures::Stream] of LiveEvents from a Live session.

Created by LiveHandle::stream(). Wraps the underlying [broadcast::Receiver] with stream semantics:

• Lagged: if this subscriber falls behind the broadcast buffer, the missed events are skipped and the stream continues with the next available event (no error item is yielded).
• Closed: when the session’s event channel closes, the stream ends (next() returns None).

Composes with all futures/tokio-stream combinators:

use futures::StreamExt;

let mut stream = handle.stream();
while let Some(ev) = stream.next().await {
    match ev {
        LiveEvent::TextDelta(t) => print!("{t}"),
        LiveEvent::TurnComplete => println!(),
        _ => {}
    }
}

Trait Implementations

impl Debug for LiveEventStream

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

Formats the value using the given formatter.

impl Stream for LiveEventStream

type Item = LiveEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut LiveEventStream>, cx: &mut Context<'_>, ) -> Poll<Option<<LiveEventStream as Stream>::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.