Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    Connected,
    Event(Box<Event>),
    Unknown(Value),
}

A single item yielded by an EventStream.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Connected

The SSE connection opened, or reopened after a reconnect.

Because a reconnect can straddle dropped frames, treat every Connected as a cue to reconcile against GET /session/{sessionID}/message.

Event(Box<Event>)

A frame that decoded cleanly into the generated event union.

Boxed because Event is a large union; keeping the variant small keeps StreamEvent (and Result<StreamEvent>) cheap to move.

Unknown(Value)

A frame whose type matched no known Event variant (or whose payload did not fit the expected shape).

The raw JSON is preserved so callers can inspect newer server events without this crate erroring out. Only genuinely non-JSON frames surface as an Err instead.

Implementations

impl StreamEvent

pub fn as_event(&self) -> Option<&Event>

The decoded Event, if this item is StreamEvent::Event.

pub fn is_connected(&self) -> bool

Whether this item marks a fresh (re)connection.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.