Struct axum::response::Sse

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

An SSE response

Implementations

impl<S> Sse<S>

pub fn new(stream: S) -> Self

where S: TryStream<Ok = Event> + Send + 'static, S::Error: Into<BoxError>,

Create a new Sse response that will respond with the given stream of Events.

See the module docs for more details.

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

Configure the interval between keep-alive messages.

Defaults to no keep-alive messages.

Trait Implementations

impl<S: Clone> Clone for Sse<S>

fn clone(&self) -> Sse<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for Sse<S>

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

Formats the value using the given formatter.

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

where S: Stream<Item = Result<Event, E>> + Send + 'static, E: Into<BoxError>,

fn into_response(self) -> Response

Create a response.