Struct SseEvent 

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

A single Server-Sent Event.

Fields are formatted per the WHATWG SSE spec. Multi-line data strings are split on \n and emitted as separate data: lines, which the client concatenates back into a single message.

Construct comment-only frames (used for keep-alive heartbeats) with SseEvent::comment. Comments are written as :<text>\n\n and ignored by clients.

Fields

id: Option<String>

Optional event ID, sent as id: <value>.

event: Option<String>

Optional event name, sent as event: <value>.

data: String

The event payload, sent as one or more data: <line> lines.

retry: Option<u64>

Optional reconnection time hint in milliseconds, sent as retry: <ms>.

Implementations

impl SseEvent

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

Create a bare data-only event.

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

Create a comment-only frame (e.g. :keepalive).

Comments are ignored by SSE clients per the spec but keep the connection alive through proxies that close idle TCP connections.

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

Set the event ID.

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

Set the event name.

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

Set the reconnection time hint in milliseconds.

pub fn to_wire(&self) -> String

Format the event as an SSE-spec wire frame.

Multi-line data is split into separate data: lines. Carriage returns and embedded newlines inside scalar fields are stripped so they cannot terminate the frame prematurely. The frame ends with a blank line.

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 Default for SseEvent

fn default() -> SseEvent

Returns the “default value” for a type.