pub struct Event { /* private fields */ }
Expand description
Server-sent event
Implementations
sourceimpl Event
impl Event
sourcepub fn data<T>(self, data: T) -> Event where
T: AsRef<str>,
pub fn data<T>(self, data: T) -> Event where
T: AsRef<str>,
Set the event’s data data field(s) (data:<content>
)
Newlines in data
will automatically be broken across data:
fields.
This corresponds to MessageEvent
’s data field.
Panics
- Panics if
data
contains any carriage returns, as they cannot be transmitted over SSE. - Panics if
data
orjson_data
have already been called.
sourcepub fn comment<T>(self, comment: T) -> Event where
T: AsRef<str>,
pub fn comment<T>(self, comment: T) -> Event where
T: AsRef<str>,
Set the event’s comment field (:<comment-text>
).
This field will be ignored by most SSE clients.
Unlike other functions, this function can be called multiple times to add many comments.
Panics
Panics if comment
contains any newlines or carriage returns, as they are not allowed in
comments.
sourcepub fn event<T>(self, event: T) -> Event where
T: AsRef<str>,
pub fn event<T>(self, event: T) -> Event where
T: AsRef<str>,
Set 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.
Panics
- Panics if
event
contains any newlines or carriage returns. - Panics if this function has already been called on this event.
sourcepub fn retry(self, duration: Duration) -> Event
pub fn retry(self, duration: Duration) -> Event
Set 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.
Panics
Panics if this function has already been called on this event.
sourcepub fn id<T>(self, id: T) -> Event where
T: AsRef<str>,
pub fn id<T>(self, id: T) -> Event where
T: AsRef<str>,
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.
Panics
- Panics if
id
contains any newlines, carriage returns or null characters. - Panics if this function has already been called on this event.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Event
impl Send for Event
impl Sync for Event
impl Unpin for Event
impl UnwindSafe for Event
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more