Struct SseStream 

pub struct SseStream<S, B, E>
where
    S: Stream<Item = Result<B, E>>,
    B: AsRef<[u8]>,
{ /* private fields */ }

Available on crate feature stream only.

Adapts a fallible byte stream into a stream of parsed SseEvents.

Errors from the underlying byte stream are forwarded unchanged. When the byte stream ends, any buffered-but-undispatched data is discarded per the SSE specification.

The adapter keeps a single scratch Vec that the parser writes into on every poll and a VecDeque it drains from, so steady-state polling performs no per-chunk heap allocation beyond the events themselves.

Implementations

impl<S, B, E> SseStream<S, B, E>

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

pub fn new(inner: S) -> Self

Wrap a byte stream.

Trait Implementations

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

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

type Item = Result<SseEvent, 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.