Struct ServerSseMessage 

#[non_exhaustive]
pub struct ServerSseMessage {
    pub event_id: Option<String>,
    pub message: Option<Arc<ServerJsonRpcMessage>>,
    pub retry: Option<Duration>,
}

Available on (crate features client or server) and crate feature transport-streamable-http-server only.

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_id: Option<String>

The event ID for this message. When set, clients can use this ID with the Last-Event-ID header to resume the stream from this point.

message: Option<Arc<ServerJsonRpcMessage>>

The JSON-RPC message content. Set to None for priming events. See SEP-1699

retry: Option<Duration>

The retry interval hint for clients. Clients should wait this duration before attempting to reconnect. This maps to the SSE retry: field.

Implementations

impl ServerSseMessage

pub fn new(event_id: impl Into<String>, message: ServerJsonRpcMessage) -> Self

Create a message carrying a JSON-RPC response/notification with an event ID.

pub fn from_message(message: ServerJsonRpcMessage) -> Self

Wrap a JSON-RPC message without an event ID or retry hint.

pub fn priming(event_id: impl Into<String>, retry: Duration) -> Self

Create a priming event that tells the client to reconnect after retry if the connection drops. See SEP-1699.

Trait Implementations

impl Clone for ServerSseMessage

fn clone(&self) -> ServerSseMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerSseMessage

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

Formats the value using the given formatter.

impl Default for ServerSseMessage

fn default() -> ServerSseMessage

Returns the “default value” for a type.