Enum WidgetMutation 

pub enum WidgetMutation {
    SetValue {
        widget_key: String,
        value: String,
        cursor_byte: Option<i32>,
    },
    SetCompletions {
        widget_key: String,
        items: Vec<CompletionItem>,
    },
    SetChecked {
        widget_key: String,
        checked: bool,
    },
    SetSelectedIndex {
        widget_key: String,
        index: i32,
    },
    SetItems {
        widget_key: String,
        items: Vec<TextPropertyEntry>,
        item_keys: Vec<String>,
    },
    SetExpandedKeys {
        widget_key: String,
        keys: Vec<String>,
    },
    SetCheckedKeys {
        widget_key: String,
        checked: bool,
        keys: Vec<String>,
    },
    AppendTreeNodes {
        widget_key: String,
        new_nodes: Vec<TreeNode>,
        new_item_keys: Vec<String>,
    },
    SetRawEntries {
        widget_key: String,
        entries: Vec<TextPropertyEntry>,
    },
    SetFocusKey {
        widget_key: String,
    },
}

Targeted in-place mutation of a mounted widget panel — the IPC fast path. Plugins use these when the model change touches one widget; the host applies the mutation directly to the panel’s spec / instance state and re-renders without re-transmitting the full spec.

UpdateWidgetPanel remains the right tool for structural changes (adding/removing widgets, restructuring layout). Both paths preserve instance state via widget keys.

Variants

SetValue

Set a TextInput’s value and (optionally) cursor byte. Mutates instance state directly.

Fields

widget_key: String

value: String

cursor_byte: Option<i32>

SetCompletions

Set a Text widget’s completion candidates (instance state). Empty items closes the popup; non-empty opens it and resets the selection to index 0. Plugins call this from their change event handler after computing candidates against the new value — same flow as setPromptSuggestions for the legacy prompt UI.

Fields

widget_key: String

items: Vec<CompletionItem>

SetChecked

Set a Toggle’s checked state. Mutates the Toggle’s checked field in the spec.

Fields

widget_key: String

checked: bool

SetSelectedIndex

Set a List’s selected index (instance state).

Fields

widget_key: String

index: i32

SetItems

Replace a List’s items + parallel item_keys. Mutates the List in the spec.

Fields

widget_key: String

items: Vec<TextPropertyEntry>

item_keys: Vec<String>

SetExpandedKeys

Replace a Tree’s expanded-keys instance state. Plugins use this when a non-user action needs to drive expansion (e.g. “expand all”, reveal-on-search). Right/Left arrow keys and disclosure clicks already mutate expansion host-side without the plugin’s involvement.

Fields

widget_key: String

keys: Vec<String>

SetCheckedKeys

Set checked to the given value on every node in keys. Mutates the Tree’s nodes in the spec; the renderer sees the change on the next paint without a full spec re-emit. Used by the toggle event handler in plugins to push the new checkbox state back after a user click or x keypress.

Fields

widget_key: String

checked: bool

keys: Vec<String>

AppendTreeNodes

Append new_nodes (and parallel new_item_keys) to an existing Tree’s node list. Streaming-friendly counterpart to SetItems: a plugin streaming thousands of results sends only the per-batch delta instead of re-transmitting the entire tree on every batch. Existing selection / scroll / expansion state is preserved across the append.

Fields

widget_key: String

new_nodes: Vec<TreeNode>

new_item_keys: Vec<String>

SetRawEntries

Replace a Raw widget’s entries in place. The streaming search pump uses this to update small bits of chrome (the matchStats label, the separator “Matches (N in M files)” header) without re-emitting the full panel spec — the latter would force a js_to_json walk of every node in a 5 000-row tree once streaming finishes, blocking the JS thread for ~1 second.

Fields

widget_key: String

entries: Vec<TextPropertyEntry>

SetFocusKey

Set the panel’s focused widget to widget_key. Passing a key that isn’t a tabbable in the current spec is harmless — the next render clamps focus to the first tabbable, same as for an empty key. Use this to land initial focus on a specific widget after mount, or to snap focus back to a “home” widget after a navigation event.

Fields

widget_key: String

Trait Implementations

impl Clone for WidgetMutation

fn clone(&self) -> WidgetMutation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetMutation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetMutation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WidgetMutation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for WidgetMutation

type WithoutGenerics = WidgetMutation

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = WidgetMutation

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.