Skip to main content

UiDialogMailbox

Struct UiDialogMailbox 

Source
pub struct UiDialogMailbox { /* private fields */ }
Expand description

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§

Source§

impl UiDialogMailbox

Source

pub fn new() -> Self

Source

pub fn attach(&self)

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

Source

pub fn detach(&self)

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

Source

pub fn is_attached(&self) -> bool

Source

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.

Source

pub fn pending_len(&self) -> usize

Source

pub fn is_pending(&self, request_id: &str) -> bool

Inspect lifecycle without consuming the answer reserved for a plugin.

Source

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.

Source

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.

Source

pub fn cancel_all(&self)

Cancel all requests currently known to the mailbox.

Source

pub fn cancel_tool_call(&self, tool_call_id: &str)

Cancel approval requests belonging to one tool without disturbing questions from concurrent tool calls.

Source

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.

Source

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§

Source§

impl Clone for UiDialogMailbox

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for UiDialogMailbox

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more