Skip to main content

CompletionData

Struct CompletionData 

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

Thread-safe storage for dynamic command and argument completions.

Clone this handle and pass it to background threads that need to update available completions (e.g. when the harness sends a model list or an extension publishes an action schema).

Implementations§

Source§

impl CompletionData

Source

pub fn new() -> Self

Creates empty, shareable dynamic completion storage.

Source

pub fn set_dynamic_commands(&self, commands: Vec<CommandCompletion>)

Replaces extension-provided root commands shown alongside the static command registry.

Source

pub fn set_dynamic_commands_and_arg_completers( &self, commands: Vec<CommandCompletion>, arg_completers: Vec<(CommandName, ArgCompleter)>, )

Replaces extension-provided root commands and their nested argument/subcommand completers as one atomic snapshot.

Source

pub fn set_static_command_descriptions( &self, descriptions: impl IntoIterator<Item = (CommandName, String)>, )

Replaces descriptions for existing intrinsic command-root candidates.

This changes display text only: it cannot add a command or alter its insertion text.

Source

pub fn set_arg_completions( &self, command: CommandName, items: Vec<CompletionItem>, )

Sets a flat, single-arg completion list for a command. Items are ranked prefix-match-first, substring-match-second (case-insensitive). For commands that take more than one arg or need to react to prior args, use CompletionData::set_arg_completer.

Source

pub fn set_arg_completer(&self, command: CommandName, completer: ArgCompleter)

Registers a custom argument completer for a command. The closure receives the args typed so far (with the partial last element being completed) and returns ranked candidates.

Source

pub fn set_agent_mention_completer(&self, completer: ArgCompleter)

Registers prompt-text completion for active agent mentions typed as @<partial-agent-id>.

Source

pub fn set_session_completer(&self, completer: ArgCompleter)

Registers prompt-text completion for running sessions typed as &<partial-session-id>.

Trait Implementations§

Source§

impl Clone for CompletionData

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 CompletionData

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<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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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