Enum ClientMessage 

pub enum ClientMessage {
    Subscribe {
        topics: Vec<String>,
    },
    Unsubscribe {
        topics: Vec<String>,
    },
    Write {
        topic: String,
        payload: Value,
    },
    Ping,
    Query {
        id: String,
        pattern: String,
        from: Option<u64>,
        to: Option<u64>,
        limit: Option<usize>,
    },
    ListTopics {
        id: String,
    },
}

A message received from a WebSocket client.

Variants

Subscribe

Subscribe to one or more topics (wildcards supported).

Fields

topics: Vec<String>

Unsubscribe

Unsubscribe from one or more topics.

Fields

topics: Vec<String>

Write

Write a value to an inbound record (link_from("ws://…")).

Fields

topic: String

payload: Value

Ping

Keepalive ping.

Query

Query historical / persisted records.

The server responds with ServerMessage::QueryResult carrying the same id for correlation.

Fields

id: String

Client-generated correlation ID (echoed in the response).

pattern: String

Topic pattern to match (MQTT wildcards supported, "*" for all).

from: Option<u64>

Start of time range (milliseconds since Unix epoch), inclusive. Defaults to 1 h ago.

to: Option<u64>

End of time range (milliseconds since Unix epoch), inclusive. Defaults to now.

limit: Option<usize>

Maximum number of records to return per matching topic.

ListTopics

Request the list of topics served by this WebSocket endpoint.

The server responds with ServerMessage::TopicList carrying the same id for correlation.

Fields

id: String

Client-generated correlation ID (echoed in the response).

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClientMessage

fn eq(&self, other: &ClientMessage) -> 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 ClientMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientMessage