Struct AgentMessage 

pub struct AgentMessage {
    pub version: String,
    pub payload: AgentPayload,
}

One agent → renderer message.

Fields

version: String

Protocol version stamped on the wire; defaults to PROTOCOL_VERSION.

payload: AgentPayload

The single payload key that gives this message its type.

Implementations

impl AgentMessage

pub fn new(payload: AgentPayload) -> Self

Wraps a payload with the current protocol version.

pub fn create_surface( surface_id: impl Into<String>, catalog_id: impl Into<String>, ) -> Self

createSurface: allocate a surface and fix its catalogId.

Re-creating a surfaceId that already exists is an error per spec; see crate::toolkit::ops::assemble_ops, which omits this message when the intent is to update an existing surface.

pub fn update_components( surface_id: impl Into<String>, components: Vec<Component>, ) -> Self

updateComponents: add or replace components on an existing surface.

pub fn update_data_model( surface_id: impl Into<String>, path: impl Into<String>, value: Value, ) -> Self

updateDataModel: upsert value at path (JSON Pointer, / = whole model).

pub fn delete_surface(surface_id: impl Into<String>) -> Self

deleteSurface: drop a surface and everything under it.

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

The surfaceId this message targets, if it targets one.

Function-call messages are addressed by functionCallId rather than by surface, so they return None.

Trait Implementations

impl Clone for AgentMessage

fn clone(&self) -> AgentMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AgentMessage

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

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 AgentMessage