Enum ControlMessage 

pub enum ControlMessage {
    Hello {
        protocol_version: i64,
        session_id: String,
        actor_id: String,
        client_id: String,
        cursor: i64,
        latest_cursor: i64,
        requires_sync: bool,
        timestamp: i64,
    },
    Wake {
        cursor: i64,
        requires_pull: bool,
        reason: WakeReason,
        timestamp: i64,
    },
    Heartbeat {
        timestamp: i64,
    },
    Ack {
        cursor: i64,
    },
    Presence {
        scope_key: String,
        kind: Option<PresenceKind>,
        actor_id: Option<String>,
        client_id: Option<String>,
        doc: Option<Value>,
        error: Option<String>,
        timestamp: Option<i64>,
    },
    Unknown(Value),
}

Variants

Hello

§8.1 connect handshake.

Fields

protocol_version: i64

session_id: String

actor_id: String

client_id: String

cursor: i64

latest_cursor: i64

requires_sync: bool

timestamp: i64

Wake

§8.3 wake-up (event = "sync").

Fields

cursor: i64

requires_pull: bool

reason: WakeReason

timestamp: i64

Heartbeat

§8.5 heartbeat.

Fields

timestamp: i64

Ack

§8.2 client ack — the sole client→server control message.

Fields

cursor: i64

Presence

§8.6.2 presence fanout (server→client) or a publisher-directed error.

Fields

scope_key: String

kind: Option<PresenceKind>

join | update | leave for a fanout; None for an error.

actor_id: Option<String>

client_id: Option<String>

doc: Option<Value>

The peer’s document for join/update; None/null for leave.

error: Option<String>

presence.too_large / presence.forbidden (§8.6.2), if this is a publisher-directed error variant.

timestamp: Option<i64>

Unknown(Value)

Unknown JSON control event, tolerated and preserved (§8.1).

Trait Implementations

impl Clone for ControlMessage

fn clone(&self) -> ControlMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlMessage

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

Formats the value using the given formatter.

impl PartialEq for ControlMessage

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