Enum RemoteMessage 

pub enum RemoteMessage {
    InitialTree(InitialTree),
    Patch(PatchStream),
    DispatchAction {
        module: String,
        action: String,
        payload: Option<Value>,
    },
    StateUpdate {
        module: String,
        state: Value,
    },
}

Wire protocol messages for Remote UI (server-driven rendering).

Remote UI allows the Hypen engine to run on a server while a thin client (browser, mobile app, embedded device) renders the UI. Communication is bidirectional over WebSocket, SSE, or any ordered transport.

Message Flow

Server                           Client
  │                                │
  │──── InitialTree ──────────────>│  (full tree + state on connect)
  │                                │
  │──── Patch ─────────────────────>│  (incremental updates)
  │                                │
  │<─── DispatchAction ────────────│  (user interaction)
  │                                │
  │──── StateUpdate ──────────────>│  (state sync after action)
  │──── Patch ─────────────────────>│  (resulting UI changes)

Revision Tracking

Each InitialTree and PatchStream carries a monotonically increasing revision number. Clients should:

• Apply patches in revision order
• Detect gaps (missed patches) and request a full InitialTree
• Ignore patches with a revision ≤ the last applied revision

Integrity Hashing

The optional hash field on InitialTree and PatchStream enables end-to-end integrity verification. When present, clients can hash their tree state and compare to detect corruption or missed patches.

Serialization

Messages serialize with a "type" discriminator in camelCase:

{"type": "initialTree", "module": "App", "state": {...}, "patches": [...], "revision": 0}
{"type": "patch", "module": "App", "patches": [...], "revision": 1}
{"type": "dispatchAction", "module": "App", "action": "click", "payload": null}
{"type": "stateUpdate", "module": "App", "state": {...}}

Variants

InitialTree(InitialTree)

Full tree snapshot sent when a client first connects.

Contains the complete state and the full patch sequence needed to construct the tree from scratch.

Patch(PatchStream)

Incremental patch stream for state-driven updates.

DispatchAction

Action dispatched from the client (user interaction).

The server should route this to the module’s action handler and respond with a StateUpdate + Patch if state changed.

Fields

module: String

Target module name

action: String

Action name (e.g. "increment", "submit")

payload: Option<Value>

Optional action payload

StateUpdate

State update pushed from the server to the client.

Sent after an action handler modifies state, so the client can keep its local state cache in sync.

Fields

module: String

state: Value

Trait Implementations

impl Clone for RemoteMessage

fn clone(&self) -> RemoteMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RemoteMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RemoteMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.