Struct hyper_usse::Event

pub struct Event {
    pub id: Option<Cow<'static, str>>,
    pub event: Option<Cow<'static, str>>,
    pub data: Cow<'static, str>,
}

A server sent event.

The fields id, event and data set the id, event and data parameters for the event respectively. id and event are optional. To convert it to an SSE string, use the to_sse function.

Examples

let event = hyper_usse::Event::new("some text\nmore text").set_id("1").set_event("send_text");
assert_eq!(event.to_sse(), "id: 1
event: send_text
data: some text
data: more text\n\n");

Fields

id: Option<Cow<'static, str>>

event: Option<Cow<'static, str>>

data: Cow<'static, str>

Methods

impl Event

pub fn new<T: Into<Cow<'static, str>>>(data: T) -> Self

Creates a new Event from data.

pub fn set_id<T: Into<Cow<'static, str>>>(self, id: T) -> Self

Sets the id of the event. As it returns self, it is useful for creating an event inline.

pub fn set_event<T: Into<Cow<'static, str>>>(self, event: T) -> Self

Sets the event type of the event. Like set_id, it returns self and so can easily be chained.

pub fn to_sse(&self) -> String

Converts the Event to an SSE string.

Trait Implementations

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.