Struct EventStream 

pub struct EventStream { /* private fields */ }

Available on crate feature sse only.

A Stream of Events decoded from a text/event-stream response body.

Created by Conn::into_sse. The stream yields Result<Event, trillium_http::Error>; an error item is an IO failure reading the underlying transport, after which the stream ends. The stream ends with None when the connection closes; an incomplete event at end-of-stream (no terminating blank line) is discarded per the specification.

Implementations

impl EventStream

pub fn new(conn: Conn) -> Result<Self, SseError>

Read an already-executed Conn’s response body as an event stream, with no validation of its status or content-type.

Conn::into_sse is the normal entry point; this is the escape hatch for a response that fails its checks but that the caller knows is an event stream anyway — typically recovered from an SseError via From/Into. The SSE wire format accepts any input, so a body that is not actually an event stream yields no events rather than an error.

Errors

SseErrorKind::NoBody if the conn has not been executed, so there is no response to read.

pub fn conn(&self) -> &Conn

The executed Conn this stream was created from, for response metadata — status, response headers, peer address.

Trait Implementations

impl Debug for EventStream

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

Formats the value using the given formatter.

impl Stream for EventStream

type Item = Result<Event, Error>

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.