Struct EventStream 

pub struct EventStream<S> { /* private fields */ }

Adapter from a stream of byte chunks to a stream of SSE events.

Works with any Stream<Item = Result<B, E>> where B: AsRef<[u8]>, which covers Vec<u8>, &[u8], bytes::Bytes, and HTTP client bodies. Executor-agnostic: the only async dependency is the futures-core Stream trait.

Every completed event is yielded before the inner stream is polled again. When the inner stream ends, the parser is finished, remaining events are yielded, and the stream terminates. Polling after termination returns Ready(None) without touching the inner stream. A transport error is yielded as an item and the stream stays usable.

Implementations

impl<S> EventStream<S>

pub fn new(stream: S) -> Self

Wrap a byte-chunk stream.

pub fn set_last_event_id(&mut self, id: impl Into<String>)

Seed the last event ID string, for reconnection. Events dispatched before the stream’s first id field report this ID.

pub fn last_event_id(&self) -> &str

The last event ID string. See SseParser::last_event_id.

pub fn retry(&self) -> Option<Duration>

Reconnection time from the most recent valid retry field, if any. See SseParser::retry.

Trait Implementations

impl<S: Debug> Debug for EventStream<S>

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

Formats the value using the given formatter.

impl<S, B, E> FusedStream for EventStream<S>

where S: Stream<Item = Result<B, E>>, B: AsRef<[u8]>,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<S, B, E> Stream for EventStream<S>

where S: Stream<Item = Result<B, E>>, B: AsRef<[u8]>,

type Item = Result<Event, Error<E>>

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.

impl<'__pin, S> Unpin for EventStream<S>

where PinnedFieldsOf<__Origin<'__pin, S>>: Unpin,