Enum StreamMessage 

pub enum StreamMessage {
    Subscribe {
        id: String,
        source: String,
        transform: Option<String>,
        interval_ms: Option<u64>,
    },
    Unsubscribe {
        id: String,
    },
    Data {
        id: String,
        payload: Value,
        seq: u64,
        timestamp: Option<u64>,
    },
    Error {
        id: Option<String>,
        message: String,
        code: Option<i32>,
    },
    Ack {
        id: String,
        status: Option<String>,
    },
    Ping {
        timestamp: u64,
    },
    Pong {
        timestamp: u64,
    },
}

Stream message types for the protocol.

Variants

Subscribe

Subscribe to a data source

Fields

id: String

Subscription ID

source: String

Data source path

transform: Option<String>

Optional transform expression

interval_ms: Option<u64>

Refresh interval in milliseconds

Unsubscribe

Unsubscribe from a data source

Fields

id: String

Subscription ID

Data

Data update from server

Fields

id: String

Subscription ID this data belongs to

payload: Value

The payload data

seq: u64

Sequence number for ordering

timestamp: Option<u64>

Timestamp of the data

Error

Error message

Fields

id: Option<String>

Related subscription ID (if any)

message: String

Error message

code: Option<i32>

Error code

Ack

Acknowledgment

Fields

id: String

Subscription ID being acknowledged

status: Option<String>

Status message

Ping

Heartbeat/ping

Fields

timestamp: u64

Timestamp

Pong

Heartbeat response

Fields

timestamp: u64

Echo of ping timestamp

Implementations

impl StreamMessage

pub fn subscribe( id: impl Into<String>, source: impl Into<String>, ) -> StreamMessage

Create a subscribe message.

pub fn subscribe_with_transform( id: impl Into<String>, source: impl Into<String>, transform: impl Into<String>, ) -> StreamMessage

Create a subscribe message with transform.

pub fn unsubscribe(id: impl Into<String>) -> StreamMessage

Create an unsubscribe message.

pub fn data(id: impl Into<String>, payload: Value, seq: u64) -> StreamMessage

Create a data message.

pub fn error(message: impl Into<String>) -> StreamMessage

Create an error message.

pub fn error_for( id: impl Into<String>, message: impl Into<String>, ) -> StreamMessage

Create an error message for a subscription.

pub fn ack(id: impl Into<String>) -> StreamMessage

Create an ack message.

pub fn ping(timestamp: u64) -> StreamMessage

Create a ping message.

pub fn pong(timestamp: u64) -> StreamMessage

Create a pong message.

pub fn subscription_id(&self) -> Option<&str>

Get the subscription ID if this message has one.

Trait Implementations

impl Clone for StreamMessage

fn clone(&self) -> StreamMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<StreamMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamMessage

impl PartialEq for StreamMessage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamMessage