Struct EventStream 

pub struct EventStream { /* private fields */ }

Pollable async stream of ServerEvents.

EventStream is the public-facing receiver returned by crate::embed::ServerHandle::subscribe_events. It wraps a tokio::sync::broadcast::Receiver and translates the RecvError::Lagged shape into a synthesized ServerEvent::Lagged so consumers can stay on the happy path.

Implementations

impl EventStream

pub async fn recv(&mut self) -> Option<ServerEvent>

Receive the next event.

Returns None when the bus is closed (the server has shut down and dropped its EventBus). On lag, returns a synthesized ServerEvent::Lagged and resumes from the freshest event in the buffer.

Examples

use dynomite::embed::events::EventBus;
// The bus is published-to only by the engine; subscribers
// poll for events. Dropping the bus closes the stream.
let bus = EventBus::new(2);
let mut s = bus.subscribe();
drop(bus);
assert!(s.recv().await.is_none());

pub fn try_recv(&mut self) -> Option<ServerEvent>

Non-blocking poll: returns the next event if one is already buffered, else None.

Examples

use dynomite::embed::events::EventBus;
let bus = EventBus::new(2);
let mut s = bus.subscribe();
assert!(s.try_recv().is_none());

Trait Implementations

impl Debug for EventStream

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

Formats the value using the given formatter.