Struct afire::server_sent_events::ServerSentEventStream

pub struct ServerSentEventStream {
    pub last_index: Option<u32>,
    /* private fields */
}

A server-sent event stream.

For more information and usage examples, visit the module level documentation.

Fields

last_index: Option<u32>

If the EventSource connection gets reset, the client will send the last received event id in the Last-Event-ID header. This will be available here, if applicable.

Implementations

impl ServerSentEventStream

pub fn send(&self, event_type: impl AsRef<str>, data: impl Display)

Sends a new event with the given event type and data.

pub fn send_id(&self, event_type: impl AsRef<str>, id: u32, data: impl Display)

Sends a new event with the given event type and id.

pub fn send_event(&self, event: Event)

Sends a new event with an Event struct.

pub fn set_retry(&self, retry: u32)

Sets the retry interval in milliseconds. Calling this will signal the client to try to reconnect after the given amount of milliseconds.

pub fn close(&self)

Closes the SSE stream. This will leave the socket open, so a new SSEStream could be created. Note: The client will likely try to reconnect automatically after a few seconds.

pub fn from_request(this: &Request) -> Result<Self>

Creates a new SSE stream from the given request. This is called automatically if you use the ServerSentEventsExt trait’s .sse() method.