Struct SseStream 

pub struct SseStream { /* private fields */ }

Streaming HTTP body that serializes SseEvents from an mpsc channel.

Implements http_body::Body so it can be carried as FerroBody::Stream through the framework’s hyper serve loop. The stream ends when the mpsc::Sender is dropped.

A :ping\n\n keep-alive comment is emitted every 15 seconds while the channel is idle. Any real event resets the idle window.

Bounded back-pressure

The internal channel is bounded (default 16 slots via SseStream::channel). If the client is too slow, Sender::send().await will apply back-pressure to the producer.

Connection count limits

Each active SseStream holds a TCP connection open. Connection-count limits are the application’s responsibility, not this primitive’s.

Implementations

impl SseStream

pub fn channel(buffer: usize) -> (Sender<SseEvent>, Self)

Create a bounded channel for pushing events and the streaming body.

Returns (sender, stream). The handler holds the sender and pushes events from a spawned task; the stream is wrapped in an HttpResponse::sse response.

Uses interval_at with an initial delay equal to interval_period so that the first ping is deferred — avoiding an immediate :ping frame on connection.

pub fn is_closed(&self) -> bool

Returns true if the internal channel has been closed (sender dropped).

Trait Implementations

impl Body for SseStream

type Data = Bytes

Values yielded by the Body.

type Error = Infallible

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Bytes>, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.