Struct SseStream 

pub struct SseStream<E, S> { /* private fields */ }

A typed SSE response stream.

Wraps a Stream of Result<E, Err> and produces an axum::response::sse::Sse response on IntoResponse. Each stream item is serialized to JSON and framed with the event name returned by SseEventMeta::event_name.

The SseStream newtype is what the #[derive(SseEvent)] integration reads at documentation-generation time to attach the text/event-stream response and its schema to the operation — handlers that return SseStream<E, _> get the right OpenAPI description for free.

Keep-alive comments are enabled by default so intermediaries do not close idle connections; swap via Self::with_keep_alive.

Implementations

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

pub fn new(stream: S) -> Self

Wrap a stream of events. Enables the default keep-alive.

pub fn with_keep_alive(self, keep_alive: Option<KeepAlive>) -> Self

Replace the keep-alive configuration. Pass None to disable keep-alive frames entirely.

Trait Implementations

impl<E, S> DocResponseBody for SseStream<E, S>

where E: PartialSchema + ToSchema + 'static,

fn describe(op: &mut Operation, schemas: &mut Vec<(String, RefOr<Schema>)>)

Add the success response entry to op and append any referenced schemas to schemas.

impl<E, S, Err> IntoResponse for SseStream<E, S>

where E: SseEventMeta + Serialize + Send + 'static, S: Stream<Item = Result<E, Err>> + Send + Unpin + 'static, Err: Error + Send + Sync + 'static,

fn into_response(self) -> Response

Create a response.