Struct Event 

pub struct Event { /* private fields */ }

One server-sent event.

Implementations

impl Event

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

An event carrying text (any text; line breaks are kept).

pub fn json<T: Serialize>(value: &T) -> Result<Self, Error>

An event carrying value as JSON.

Errors

Serialization errors of value.

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

A comment only (: text), which clients ignore: useful to keep a connection active.

pub fn event(self, name: impl Into<String>) -> Result<Self, SseError>

Name the event (the client’s addEventListener type).

Errors

SseError::EventName when name contains CR or LF.

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

Set the id clients send back as Last-Event-ID when reconnecting.

Errors

SseError::Id when id contains CR, LF or NUL.

pub fn retry(self, delay: Duration) -> Self

Ask clients to wait delay before reconnecting (whole milliseconds).

pub fn encode(&self) -> String

The event in text/event-stream form, ending with a blank line.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.

impl Eq for Event

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Event