Struct Sse 

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

Server-Sent Events response wrapper

Wraps a stream of SseEvent items and converts them to an SSE response.

Example

use rustapi_core::sse::{Sse, SseEvent};
use futures_util::stream;

async fn events() -> Sse<impl Stream<Item = Result<SseEvent, std::convert::Infallible>>> {
    let stream = stream::iter(vec![
        Ok(SseEvent::new("Hello")),
        Ok(SseEvent::new("World").event("greeting")),
    ]);
    Sse::new(stream)
}

Implementations

impl<S> Sse<S>

pub fn new(stream: S) -> Self

Create a new SSE response from a stream

pub fn keep_alive(self, interval: Duration) -> Self

Set the keep-alive interval

When set, the server will send a comment (:keep-alive) at the specified interval to keep the connection alive.

Trait Implementations

impl<S, E> IntoResponse for Sse<S>

where S: Stream<Item = Result<SseEvent, E>> + Send + 'static, E: Error + Send + Sync + 'static,

fn into_response(self) -> Response

Convert self into a Response