Struct trillium_sse::Event

source ·
pub struct Event { /* private fields */ }
Expand description

Events are a concrete implementation of the Eventable trait.

Implementations§

source§

impl Event

source

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

source

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");
source

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"));
source

pub fn data(&self) -> &str

returns this Event’s data as a &str

source

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

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

Trait Implementations§

source§

impl Clone for Event

source§

fn clone(&self) -> Event

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Event

source§

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

Formats the value using the given formatter. Read more
source§

impl Eventable for Event

source§

fn data(&self) -> &str

return the data for this event. non-optional.
source§

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

return the event type, optionally
source§

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

return a unique event id, optionally
source§

impl From<&'static str> for Event

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<String> for Event

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl PartialEq for Event

source§

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

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

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.
source§

impl Eq for Event

source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.