Struct EventBuilder

pub struct EventBuilder<'data, 'id, 'event> {
    pub data: &'data str,
    pub id: Option<&'id str>,
    pub event_type: Option<&'event str>,
}

A struct used to build server sent events.

Examples

Build an event with just data:

EventBuilder::new("Data").build();

Build an event with an ID:

EventBuilder::new("Data").id("Id").build();

Build an event with an event type:

EventBuilder::new("Data").event_type("update").build();

Because EventBuilder implements Into<Bytes> you don’t have to call build to pass it to the server.

Fields

data: &'data str

id: Option<&'id str>

event_type: Option<&'event str>

Implementations

impl<'data, 'id, 'event> EventBuilder<'data, 'id, 'event>

pub fn new(data: &'data str) -> Self

Create a new builder with data, no id and no event type.

pub fn data(self, data: &'data str) -> Self

Set the data.

pub fn id(self, id: &'id str) -> Self

Set the event id.

pub fn event_type(self, event_type: &'event str) -> Self

Set the event type.

pub fn clear_id(self) -> Self

Clear the event id.

pub fn clear_type(self) -> Self

Clear the event type.

pub fn build(self) -> String

Build the event.

Trait Implementations

impl<'data, 'id, 'event> Clone for EventBuilder<'data, 'id, 'event>

fn clone(&self) -> EventBuilder<'data, 'id, 'event>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data, 'id, 'event> Debug for EventBuilder<'data, 'id, 'event>

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

Formats the value using the given formatter.

impl<'data, 'id, 'event> Display for EventBuilder<'data, 'id, 'event>

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

Formats the value using the given formatter.

impl<'data, 'id, 'event> Into<Bytes> for EventBuilder<'data, 'id, 'event>

fn into(self) -> Bytes

Converts this type into the (usually inferred) input type.

impl<'data, 'id, 'event> PartialEq for EventBuilder<'data, 'id, 'event>

fn eq(&self, other: &EventBuilder<'data, 'id, 'event>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'data, 'id, 'event> Copy for EventBuilder<'data, 'id, 'event>

impl<'data, 'id, 'event> Eq for EventBuilder<'data, 'id, 'event>

impl<'data, 'id, 'event> StructuralPartialEq for EventBuilder<'data, 'id, 'event>