Enum RendererMessage 

pub enum RendererMessage {
    Hello {
        name: String,
        render_target: Value,
        capabilities: Value,
        instances: Option<Vec<InstanceSnapshot>>,
    },
    Ping,
    LoadResult {
        request_id: Uuid,
        instance_id: InstanceId,
        graphic_id: String,
        data: Option<Value>,
        status_code: u16,
        status_message: Option<String>,
    },
    PlayActionResult {
        request_id: Uuid,
        instance_id: InstanceId,
        status_code: u16,
        status_message: Option<String>,
        current_step: f64,
    },
    StopActionResult {
        request_id: Uuid,
        instance_id: InstanceId,
        status_code: u16,
        status_message: Option<String>,
    },
    UpdateActionResult {
        request_id: Uuid,
        instance_id: InstanceId,
        data: Option<Value>,
        status_code: u16,
        status_message: Option<String>,
    },
    CustomActionResult {
        request_id: Uuid,
        instance_id: InstanceId,
        status_code: u16,
        status_message: Option<String>,
    },
    RendererCustomActionResult {
        request_id: Uuid,
        status_code: u16,
        status_message: Option<String>,
        result: Option<Value>,
    },
    ClearResult {
        request_id: Uuid,
        instance_id: InstanceId,
        status_code: u16,
        status_message: Option<String>,
    },
}

Messages received from a renderer over its WebSocket.

Variants

Hello

Fields

name: String

render_target: Value

capabilities: Value

instances: Option<Vec<InstanceSnapshot>>

Optional instance state snapshots for reconnect state resync — if present, Core will populate the session’s instances from this list rather than starting empty (Wish 3: renderer reconnect state resync).

Ping

LoadResult

Fields

request_id: Uuid

instance_id: InstanceId

graphic_id: String

data: Option<Value>

status_code: u16

status_message: Option<String>

PlayActionResult

Fields

request_id: Uuid

instance_id: InstanceId

status_code: u16

status_message: Option<String>

current_step: f64

StopActionResult

Fields

request_id: Uuid

instance_id: InstanceId

status_code: u16

status_message: Option<String>

UpdateActionResult

Fields

request_id: Uuid

instance_id: InstanceId

data: Option<Value>

status_code: u16

status_message: Option<String>

CustomActionResult

Fields

request_id: Uuid

instance_id: InstanceId

status_code: u16

status_message: Option<String>

RendererCustomActionResult

Fields

request_id: Uuid

status_code: u16

status_message: Option<String>

result: Option<Value>

ClearResult

Fields

request_id: Uuid

instance_id: InstanceId

status_code: u16

status_message: Option<String>

Implementations

impl RendererMessage

pub fn request_id(&self) -> Option<Uuid>

The correlation id this message is a reply to, if any (Hello/Ping carry none since nothing on the server side is awaiting them).

pub fn is_success(&self) -> bool

Whether this result message indicates success (status_code < 400). Returns false for Hello/Ping which carry no status code.

Trait Implementations

impl Clone for RendererMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RendererMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RendererMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.