rama::http::sse

Struct Event

pub struct Event<T = String> { /* private fields */ }

Expand description

Server-sent event

Implementations§

§

impl<T> Event<T>

pub fn new() -> Event<T>

Create a new Event.

§

impl<T> Event<T>

pub fn id(&self) -> Option<&str>

Return the event’s identifier field (id:<identifier>).

This corresponds to MessageEvent’s lastEventId field. If no ID is in the event itself, the browser will set that field to the last known message ID, starting with the empty string.

pub fn try_with_id( self, id: impl Into<SmolStr>, ) -> Result<Event<T>, EventBuildError>

Set the event’s identifier field (id:<identifier>).

This corresponds to MessageEvent’s lastEventId field. If no ID is in the event itself, the browser will set that field to the last known message ID, starting with the empty string.

Previously set value will be overwritten.

pub fn try_set_id( &mut self, id: impl Into<SmolStr>, ) -> Result<&mut Event<T>, EventBuildError>

Set the event’s identifier field (id:<identifier>).

This corresponds to MessageEvent’s lastEventId field. If no ID is in the event itself, the browser will set that field to the last known message ID, starting with the empty string.

Previously set value will be overwritten.

pub fn data(&self) -> Option<&T>

Return the event’s data data field(s) (data: <content>)

This corresponds to MessageEvent’s data field.

pub fn into_data(self) -> Option<T>

Consume self and return the event’s data data field(s) (data: <content>)

This corresponds to MessageEvent’s data field.

pub fn with_data(self, data: T) -> Event<T>

Set the event’s data data field(s) (data: <content>)

The serialized data will automatically break newlines across data: fields.

This corresponds to MessageEvent’s data field.

Note that events with an empty data field will be ignored by the browser. Previously set value will be overwritten.

pub fn set_data(&mut self, data: T) -> &mut Event<T>

Set the event’s data data field(s) (data: <content>)

The serialized data will automatically break newlines across data: fields.

This corresponds to MessageEvent’s data field.

Note that events with an empty data field will be ignored by the browser. Previously set value will be overwritten.

pub fn event(&self) -> Option<&str>

Return the event’s name field (event:<event-name>).

This corresponds to the type parameter given when calling addEventListener on an EventSource. For example, .event("update") should correspond to .addEventListener("update", ...). If no event type is given, browsers will fire a message event instead.

pub fn try_with_event( self, event: impl Into<SmolStr>, ) -> Result<Event<T>, EventBuildError>

Set the event’s name field (event:<event-name>).

Previously set event will be overwritten.

This corresponds to the type parameter given when calling addEventListener on an EventSource. For example, .event("update") should correspond to .addEventListener("update", ...). If no event type is given, browsers will fire a message event instead.

pub fn try_set_event( &mut self, event: impl Into<SmolStr>, ) -> Result<&mut Event<T>, EventBuildError>

Set the event’s name field (event:<event-name>).

Previously set event will be overwritten.

This corresponds to the type parameter given when calling addEventListener on an EventSource. For example, .event("update") should correspond to .addEventListener("update", ...). If no event type is given, browsers will fire a message event instead.

pub fn retry(&self) -> Option<Duration>

Return the event’s retry timeout field (retry:<timeout>).

This sets how long clients will wait before reconnecting if they are disconnected from the SSE endpoint. Note that this is just a hint: clients are free to wait for longer if they wish, such as if they implement exponential backoff.

pub const fn with_static_retry(self, millis: u64) -> Event<T>

Set the event’s retry timeout field (retry:<timeout>).

Previously set retry will be overwritten.

This sets how long clients will wait before reconnecting if they are disconnected from the SSE endpoint. Note that this is just a hint: clients are free to wait for longer if they wish, such as if they implement exponential backoff.

pub fn with_retry(self, millis: u64) -> Event<T>

Set the event’s retry timeout field (retry:<timeout>).

Previously set retry will be overwritten.

This sets how long clients will wait before reconnecting if they are disconnected from the SSE endpoint. Note that this is just a hint: clients are free to wait for longer if they wish, such as if they implement exponential backoff.

pub fn set_retry(&mut self, millis: u64) -> &mut Event<T>

Set the event’s retry timeout field (retry:<timeout>).

Previously set retry will be overwritten.

This sets how long clients will wait before reconnecting if they are disconnected from the SSE endpoint. Note that this is just a hint: clients are free to wait for longer if they wish, such as if they implement exponential backoff.