Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    Chunk(String),
    Replace(String),
    Done,
    Error,
}

One markstream event.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Chunk(String)

Add this text to the end.

Replace(String)

Replace all text with this text.

Done

The stream is complete.

Error

The stream failed. The event has no details.

Implementations

impl StreamEvent

pub fn chunk(text: impl Into<String>) -> Self

Makes a StreamEvent::Chunk.

pub fn replace(text: impl Into<String>) -> Self

Makes a StreamEvent::Replace.

pub const fn name(&self) -> &'static str

The SSE event name.

pub fn data(&self) -> String

The SSE data: a JSON string, or null.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl Eq for StreamEvent

impl From<StreamEvent> for Event

fn from(event: StreamEvent) -> Self

Converts to this type from the input type.

impl PartialEq for StreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamEvent