Struct SseEvent 

pub struct SseEvent {
    pub data: String,
    pub event: Option<String>,
    pub id: Option<String>,
    pub retry: Option<u64>,
}

A single Server-Sent Event, serializable to the WHATWG text/event-stream wire format.

Field ordering in the wire output follows the WHATWG spec recommendation: event:, id:, retry:, then one or more data: lines, terminated by a blank line.

Example

let event = SseEvent::data("hello")
    .event("token")
    .id("42")
    .retry(3000);
// Wire: "event: token\nid: 42\nretry: 3000\ndata: hello\n\n"

Fields

data: String

The event payload. Multi-line strings produce repeated data: lines.

event: Option<String>

Optional named event type (event: field).

id: Option<String>

Optional last-event ID (id: field).

retry: Option<u64>

Optional client reconnection delay in milliseconds (retry: field).

Implementations

impl SseEvent

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

Create an event with the given data string.

This is the primary constructor; chain .event(), .id(), .retry() for additional fields.

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

Set the named event type.

event is a single-line SSE field. Any \n, \r, or \0 characters in the value are stripped to prevent SSE field injection (and, for id, last-event-id resets). data may contain newlines (rendered as multiple data: lines per the WHATWG spec), so it is not stripped.

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

Set the last-event ID.

id is a single-line SSE field. Any \n, \r, or \0 characters in the value are stripped to prevent SSE field injection and to avoid a null byte silently resetting the browser’s last-event-id on reconnection.

pub fn retry(self, ms: u64) -> Self

Set the client reconnection delay in milliseconds.

pub fn to_wire(&self) -> String

Serialize to the SSE wire format.

Equivalent to format!("{event}") via the Display impl.

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

Formats the value using the given formatter.

impl Display for SseEvent

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

Formats the value using the given formatter.