Enum WsMessage 

pub enum WsMessage {
    StreamInit {
        session_id: String,
        data: Value,
        options: StreamOptions,
    },
    StreamFrame {
        session_id: String,
        frame_id: u32,
        priority: u8,
        payload: Value,
        is_complete: bool,
    },
    FrameAck {
        session_id: String,
        frame_id: u32,
        processing_time_ms: u64,
    },
    StreamComplete {
        session_id: String,
        checksum: String,
    },
    Error {
        session_id: Option<String>,
        error: String,
        code: u16,
    },
    Ping {
        timestamp: u64,
    },
    Pong {
        timestamp: u64,
    },
}

WebSocket message types for PJS streaming

Variants

StreamInit

Stream initialization request

Fields

session_id: String

Identifier of the WebSocket session.

data: Value

Source JSON payload to be streamed.

options: StreamOptions

Per-stream options controlling framing and compression.

StreamFrame

Stream frame with priority data

Fields

session_id: String

Identifier of the WebSocket session.

frame_id: u32

Monotonic frame index within the session.

priority: u8

Priority assigned to this frame.

payload: Value

Payload carried by the frame.

is_complete: bool

Whether this frame completes the stream.

FrameAck

Client acknowledgment of frame

Fields

session_id: String

Identifier of the WebSocket session.

frame_id: u32

Index of the frame being acknowledged.

processing_time_ms: u64

Time the client took to process the frame, in milliseconds.

StreamComplete

Stream completion signal

Fields

session_id: String

Identifier of the WebSocket session.

checksum: String

SHA-256 checksum of the concatenated frame payloads.

Error

Error message

Fields

session_id: Option<String>

Identifier of the WebSocket session, if known.

error: String

Human-readable error description.

code: u16

Numeric error code.

Ping

Heartbeat/ping message

Fields

timestamp: u64

Wall-clock timestamp at which the ping was sent.

Pong

Heartbeat/pong response

Fields

timestamp: u64

Wall-clock timestamp at which the pong was sent.

Trait Implementations

impl Clone for WsMessage

fn clone(&self) -> WsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WsMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.