Enum WidgetInstanceState 

pub enum WidgetInstanceState {
    None,
    List {
        scroll_offset: u32,
        selected_index: i32,
    },
    Text {
        editor: TextEdit,
        scroll: u32,
        completions: Vec<CompletionItem>,
        completion_selected_index: usize,
        completion_scroll_offset: u32,
    },
    Tree {
        scroll_offset: u32,
        selected_index: i32,
        expanded_keys: HashSet<String>,
    },
}

Widget instance state retained across spec updates, keyed by the widget’s stable key. This is the “Spec/instance separation” described in §6 of the design doc — a plugin can rebuild its WidgetSpec from scratch on every model change without losing scroll offset, cursor position, expanded keys, or focus, because stateful widgets look up their instance state by key.

Variants

None

Empty/placeholder — never persisted, used as a default.

List

List instance state: host-owned scroll offset and selected index. selected_index becomes authoritative after first render — same correctness reasoning as TextInput’s host-owned value (host can mutate it via WidgetCommand::SelectMove without racing the plugin’s spec round-trip).

Fields

scroll_offset: u32

selected_index: i32

Text

Text instance state: host-owned TextEdit (value + cursor row/col + selection anchor + multiline flag), plus a viewport scroll offset that’s only meaningful for multi-line (rows > 1) variants — the row index of the first visible line. Single-line text widgets always render from value byte 0 and rely on render-time head-truncate scrolling, so they leave scroll at 0.

Becomes authoritative once the widget mounts; the spec’s value / cursor_byte are initial-only (used at first render and ignored thereafter). This guarantees correctness under concurrent keystrokes — the plugin’s spec round-trip can’t race against multiple in-flight WidgetCommand mutations because the host doesn’t read from the spec for value at all once instance state exists.

Switching from a naive (String, u32) to TextEdit is what gives the widget framework selection support, word navigation, and clipboard ops “for free” — every keybinding the legacy Settings UI accepted via TextEdit now applies to widget-backed text inputs too.

Fields

editor: TextEdit

scroll: u32

completions: Vec<CompletionItem>

Completion popup candidates the plugin most recently pushed via WidgetMutation::SetCompletions. Empty = popup closed. The list is stored host-side rather than read from each WidgetSpec so the host can keep painting the popup across renders that don’t re-push it, and so Up/Down selection survives a spec refresh.

completion_selected_index: usize

Host-managed selection cursor into completions. Reset to 0 every time SetCompletions runs with a non-empty list; clamped on every render in case the list shrank.

completion_scroll_offset: u32

Index of the first candidate row currently painted. Up/Down adjusts this implicitly (the renderer auto- scrolls to keep selection in view); the mouse wheel scrolls it directly without moving the selection.

Tree

Tree instance state: host-owned scroll offset, selected index, and the set of expanded item keys. All three become authoritative after first render — the spec’s selected_index / expanded_keys are seed values only. expanded_keys is a HashSet because expansion is set-membership semantically (a key is either expanded or not); ordering doesn’t matter and we hit-test on contains.

Fields

scroll_offset: u32

selected_index: i32

expanded_keys: HashSet<String>

Trait Implementations

impl Clone for WidgetInstanceState

fn clone(&self) -> WidgetInstanceState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetInstanceState

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

Formats the value using the given formatter.

impl Default for WidgetInstanceState

fn default() -> WidgetInstanceState

Returns the “default value” for a type.