Struct SseEvent 

#[non_exhaustive]
pub struct SseEvent {
    pub event: String,
    pub data: String,
    pub id: Option<String>,
}

One SSE event.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

event: String

The event type: the event: field, or "message" when the event has none (as in the SSE standard).

data: String

The data: fields, joined with \n. An event with no data: field is never dispatched; one with an empty data: field is, with empty data.

id: Option<String>

The last event id the stream set (id:), if any. It carries over to later events until another id: field changes it.

Implementations

impl SseEvent

pub fn new(event: impl Into<String>, data: impl Into<String>) -> Self

An event with the given type and data, and no event id.

Decoders get their events from SseStream or SseDecoder; this builds one directly, as when testing an adapter’s event mapping. Set id afterwards for an event that carries one.

use allama_http::sse::SseEvent;

let mut event = SseEvent::new("message_delta", r#"{"type":"message_delta"}"#);
assert_eq!(event.event, "message_delta");
assert_eq!(event.id, None);

event.id = Some("42".into());

Trait Implementations

impl Clone for SseEvent

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 SseEvent

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

Formats the value using the given formatter.

impl Eq for SseEvent

impl PartialEq for SseEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SseEvent