Struct Event 

pub struct Event { /* private fields */ }

Available on crate feature server only.

Message of Sse. Each event has some lines of specified fields including event, data, id, retry and comment.

Implementations

impl Event

pub fn new() -> Self

Create an empty Event

pub fn event<T>(self, event: T) -> Self

where T: AsRef<str>,

Set the event field (event: <event-name>) for the event message.

Panics

• Panics if the event field has already set.
• Panics if the event name contains \r or \n.

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

where T: AsRef<str>,

Set the data field(s) (data: <content>) for the event message.

Each line of contents will be added data: prefix when sending.

Panics

• Panics if the data field has already set through Self::data or Self::json.

pub fn json<T>(self, data: &T) -> Result<Self, Error>

where T: Serialize,

Available on crate feature json only.

Set the data field (data: <content>) by serialized data for the event message.

Each line of contents will be added data: prefix when sending.

Panics

• Panics if the data field has already set through Self::data or Self::json.

pub fn id<T>(self, id: T) -> Self

where T: AsRef<str>,

Set the id field (id: <id>) for the event message.

Panics

• Panics if the id field has already set.
• Panics if the id contains \r or \n.

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

Set the retry field (retry: <timeout>) for the event message.

Panics

• Panics if the timeout field has already set.

pub fn comment<T>(self, comment: T) -> Self

where T: AsRef<str>,

Add a comment field (: <comment-text>).

Panics

• Panics if the comment text contains \r or \n.

Trait Implementations

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.