Struct Event 

pub struct Event { /* private fields */ }

Represents a Server-Sent Event that can be sent to clients.

Implementations

impl Event

pub fn new<T: Serialize>(data: &T) -> Result<Self, Error>

Creates a new SSE event from JSON-serializable data.

This helper is available when the json feature is enabled and returns an error instead of panicking if serialization fails.

Examples

use http_kit::sse::Event;
use serde::Serialize;

#[derive(Serialize)]
struct Message { text: String }

let msg = Message { text: "Hello".to_string() };
let event = Event::new(&msg)?;

pub fn from_data<T: Into<String>>(data: T) -> Self

Creates a new SSE event from string data.

Examples

use http_kit::sse::Event;

let event = Event::from_data("Hello, World!");

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

Returns the event ID if set.

pub const fn event(&self) -> Option<&str>

Returns the event type if set.

pub const fn retry(&self) -> Option<u64>

Returns the retry duration in milliseconds if set.

pub const fn text_data(&self) -> &str

Returns the raw text data of the event.

pub fn data<T>(&self) -> Result<T, Error>

where T: for<'de> Deserialize<'de>,

Deserializes the event data as JSON.

This helper is available when the json feature is enabled.

Errors

Returns an error if the data cannot be deserialized as the specified type.

pub fn with_id<T: Into<String>>(self, id: T) -> Self

Sets the event ID.

Examples

use http_kit::sse::Event;

let event = Event::from_data("Hello").with_id("msg-123");

pub fn with_event<T: Into<String>>(self, event: T) -> Self

Sets the event type.

Examples

use http_kit::sse::Event;

let event = Event::from_data("Hello").with_event("message");

pub fn with_retry(self, retry: u64) -> Self

Sets the retry duration in milliseconds.

Examples

use http_kit::sse::Event;

let event = Event::from_data("Hello").with_retry(5000);

pub fn encode(&self) -> String

Encodes the event as an SSE-formatted string.

The output follows the SSE specification format:

• event: <type> (optional)
• data: <data>
• id: <id> (optional)
• retry: <milliseconds> (optional)
• Empty line to end the event

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.