Struct UiDialogMailbox 

pub struct UiDialogMailbox { /* private fields */ }

Thread-safe mailbox connecting plugin runtime actions to an interactive host (normally the TUI). It deliberately carries only JSON and primitives, so the extension crate remains independent of the UI crate.

Implementations

impl UiDialogMailbox

pub fn new() -> Self

pub fn attach(&self)

Mark an interactive consumer as available. Re-attaching is idempotent.

pub fn detach(&self)

Detach the consumer and cancel every outstanding request. This prevents a TUI restart/reload from leaving plugin polls blocked forever.

pub fn is_attached(&self) -> bool

pub fn take_pending(&self) -> Option<UiDialogRequest>

Remove and return the next request for presentation by the TUI. Cancelled/answered requests are skipped; duplicate open calls never enqueue the same request id twice.

pub fn pending_len(&self) -> usize

pub fn respond(&self, request_id: &str, answer: Value) -> Result<(), String>

Supply an answer for a request. Repeating the same operation is idempotent; answering a cancelled/unknown request is an explicit error.

pub fn cancel(&self, request_id: &str) -> Result<(), String>

Mark one request cancelled. The terminal state remains visible to the plugin’s next poll, then is reclaimed by that poll.

pub fn cancel_all(&self)

Cancel all requests currently known to the mailbox.

pub fn poll(&self, request_id: &str) -> Result<Value, String>

Poll a request and consume a terminal answer/cancellation. Pending polls are cheap and preserve the request for subsequent calls.

pub fn handle(&self, args: Value) -> Result<Value, String>

Parse and execute the JSON action envelope used by runtime action 17. Supported operations are open, poll, cancel; response is also accepted as a convenience for hosts that proxy answers through JSON.

Trait Implementations

impl Clone for UiDialogMailbox

fn clone(&self) -> UiDialogMailbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for UiDialogMailbox

fn default() -> Self

Returns the “default value” for a type.