Enum sse_codec::Event

pub enum Event {
    Message {
        id: Option<String>,
        event: String,
        data: String,
    },
    Retry {
        retry: u64,
    },
}

An "event", either an incoming message or some meta-action that needs to be applied to the stream.

Variants

Message

An incoming message.

Fields of Message

id: Option<String>

The ID of this event.

See also the Server-Sent Events spec.

event: String

The event type. Defaults to "message" if no event name is provided.

data: String

The data for this event.

Retry

Set the reconnection time.

See also the Server-Sent Events spec.

Fields of Retry

retry: u64

The new reconnection time in milliseconds.

Implementations

impl Event

pub fn message<'a>(
    event: &str,
    data: &str,
    id: impl Into<Option<&'a str>>
) -> Self

Create a server-sent event message.

pub fn retry(time: u64) -> Self

Create a message that configures the retry timeout.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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 Display for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl FromStr for Event

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse an event message from a string.

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 ==.

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

This method tests for !=.

impl StructuralEq for Event

impl StructuralPartialEq for Event