Struct UiInvalidateMessage 

pub struct UiInvalidateMessage {
    pub event: String,
    pub instances: Option<Vec<UiInvalidatedInstance>>,
    pub prompts_screened: Option<bool>,
    pub uuid: String,
    pub session_id: String,
}

system/ui_invalidate — a plugin called $.ui.invalidate("ui.render"), or a plugin loaded or reloaded: every tree a remote surface drew through ui_render may be stale, and the surface re-asks each mounted instance. Bumps from one plugin fold to at most one per 100 ms (CLI 2.1.285+).

Fields

event: String

The render event whose version moved — "ui.render"; the engine versions it as one event, so no component or instance is named.

instances: Option<Vec<UiInvalidatedInstance>>

Present when a plugin state write, or (CLI 2.1.289+) a Client drawn in them that failed and whose plugin heard it (ui.fault), made only these instances stale, so the surface may re-ask them alone. Absent, every mounted instance may be stale.

prompts_screened: Option<bool>

Present, and true, while a mod may change what is recorded of a typed line (a hook on prompt.submit, command.run, session.append or session.receive, mods not yet known, or an organization policy that lists a plugin or cannot be read): what the prompts_screened_v1 capability says on system/init, sent as soon as a plugin load or reload makes it so. Absent says nothing; the next system/init does (CLI 2.1.300+).

uuid: String

session_id: String

Trait Implementations

impl Clone for UiInvalidateMessage

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 UiInvalidateMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiInvalidateMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UiInvalidateMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.