Struct SseEvent 

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

A Server-Sent Event

SSE events follow the format specified in the W3C Server-Sent Events specification. Each event can have:

• data: The event data (required)
• event: The event type/name (optional)
• id: The event ID for reconnection (optional)
• retry: Reconnection time in milliseconds (optional)
• comment: A comment line (optional, not visible to most clients)

Fields

data: String

The event data

event: Option<String>

The event type/name

id: Option<String>

The event ID

retry: Option<u64>

Reconnection time in milliseconds

Implementations

impl SseEvent

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

Create a new SSE event with the given data

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

Create an SSE comment (keep-alive)

Comments are lines starting with : and are typically used for keep-alive.

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

Set the event type/name

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

Set the event ID

pub fn retry(self, retry: u64) -> SseEvent

Set the retry time in milliseconds

pub fn json_data<T>(data: &T) -> Result<SseEvent, Error>

where T: Serialize,

Set JSON data (serializes the value)

pub fn to_sse_string(&self) -> String

Format the event as an SSE message

The format follows the SSE specification:

• Lines starting with “event:” specify the event type
• Lines starting with “id:” specify the event ID
• Lines starting with “retry:” specify the reconnection time
• Lines starting with “data:” contain the event data
• Lines starting with “:” are comments
• Events are terminated with a blank line

pub fn to_bytes(&self) -> Bytes

Convert the event to bytes

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.