Struct trillium_sse::Event

pub struct Event { /* private fields */ }

Events are a concrete implementation of the Eventable trait.

Implementations

impl Event

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

builds a new Event

by default, this event has no event type. to set an event type, use Event::with_type or Event::set_type

pub fn with_type(self, event_type: impl Into<Cow<'static, str>>) -> Self

chainable constructor to set the type on an event

let event = trillium_sse::Event::new("event data").with_type("userdata");
assert_eq!(event.event_type(), Some("userdata"));
assert_eq!(event.data(), "event data");

pub fn set_type(&mut self, event_type: impl Into<Cow<'static, str>>)

set the event type for this Event. The default is None.

let mut event = trillium_sse::Event::new("event data");
assert_eq!(event.event_type(), None);
event.set_type("userdata");
assert_eq!(event.event_type(), Some("userdata"));

pub fn data(&self) -> &str

returns this Event’s data as a &str

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

returns this Event’s type as a str, if set

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

const 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 Eventable for Event

fn data(&self) -> &str

return the data for this event. non-optional.

fn event_type(&self) -> Option<&str>

return the event type, optionally

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

return a unique event id, optionally

impl From<&'static str> for Event

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<Cow<'static, str>> for Event

fn from(data: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<String> for Event

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Event

impl StructuralEq for Event

impl StructuralPartialEq for Event