Struct SseEvent 

pub struct SseEvent { /* private fields */ }

One frame in a Server-Sent Events stream. A frame may carry data (the common case), a comment (heartbeats and debug pings), and the optional event / id / retry fields. The wire encoding is handled by SseEvent::to_bytes — embedded newlines in data become multiple data: lines, the way the spec requires.

SseEvent::data("hello").event("greeting").id("42")
SseEvent::data("line1\nline2")  // becomes two `data: ...` lines
SseEvent::comment("keep-alive")

Implementations

impl SseEvent

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

New event with a data: field. The most common entry point.

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

New event with just a comment line (: ...\n\n). Comments are ignored by EventSource clients but keep the connection alive through intermediaries — useful as a heartbeat when the stream is idle for long stretches.

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

Set the event-type name (the event: field). Clients can route on this with EventSource.addEventListener(name, …). Embedded newlines are replaced with spaces (the spec doesn’t allow newlines in event names).

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

Set the id: field. The browser will replay it on reconnect via the Last-Event-ID request header — use it to support resumable streams.

pub fn retry(self, d: Duration) -> SseEvent

Set the retry: field — tells the client how long (in milliseconds) to wait before reconnecting after a drop.

pub fn to_bytes(&self) -> Bytes

Encode this event in the SSE wire format, ending with the blank-line frame separator (\n). Used by sse; you rarely need to call it directly unless you’re building a custom streaming pipeline.

Trait Implementations

impl Clone for SseEvent

fn clone(&self) -> SseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SseEvent

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

Formats the value using the given formatter.

impl Default for SseEvent

fn default() -> SseEvent

Returns the “default value” for a type.