Struct SseEvent 

pub struct SseEvent { /* private fields */ }

A single Server-Sent Event.

Build with SseEvent::data and chain the optional setter methods. Use Sse::push to add it to a response.

Implementations

impl SseEvent

pub fn data(data: impl Into<String>) -> SseEvent

Create an event with the given data payload. Multi-line strings produce multiple data: lines, which the client concatenates with \n.

pub fn id(self, id: impl Into<String>) -> SseEvent

Set the id field. Clients use this to resume from the last event seen after a reconnection (Last-Event-ID request header).

pub fn event_type(self, event: impl Into<String>) -> SseEvent

Set the event type (event field). Clients listen for specific types with addEventListener("type", handler). Defaults to "message".

pub fn retry(self, ms: u32) -> SseEvent

Set the retry reconnection delay in milliseconds. Overrides the client’s default reconnect interval.

pub fn encode(&self) -> Vec<u8>

Encode this event as SSE wire-format bytes. data is split into one data: line per line (at \n, \r\n or a lone \r, all line ends to the client); line breaks in id and the event type are dropped, so neither can add fields of its own.