Struct CommandsSource 

pub struct CommandsSource {
    pub spec: PickerSourceSpec,
    pub registry: Arc<ArcSwapAny<Arc<CommandRegistry>>>,
    pub reverse: Arc<dyn KeymapReverseLookup>,
}

:picker commands. Walks the App’s CommandRegistry and emits one row per registered ex-command (motions, operators, etc. are not user-invocable through this surface and stay out). Captures an Arc<CommandRegistry> at construction time – the registry doesn’t live on PickerContext because it’s static App-wide state, not per-invocation snapshot data.

Fields

spec: PickerSourceSpec

registry: Arc<ArcSwapAny<Arc<CommandRegistry>>>

B3b: the ArcSwap handle (not a boot snapshot) so the palette enumerates commands a plugin registered at runtime — init .load()s it per open, mirroring the reverse cache below.

reverse: Arc<dyn KeymapReverseLookup>

MP.2b: name → first-bound-chord reverse lookup. Captured at construction like registry (both are static App-wide facades, not per-open snapshot state — see the PickerContext module doc on why feature facades live here, not on the context). Each call reads the keymap’s live ArcSwap reverse cache, so a :map / :unmap between picker opens is reflected without rebuilding the source.

Implementations

impl CommandsSource

pub fn new( registry: Arc<ArcSwapAny<Arc<CommandRegistry>>>, reverse: Arc<dyn KeymapReverseLookup>, ) -> CommandsSource

Trait Implementations

impl PickerSourceGenerator for CommandsSource

fn spec(&self) -> &PickerSourceSpec

Generator metadata. Returned by reference so the registry can stamp it into :describe-picker / :picker <Tab> listings without cloning.

fn init( &self, ctx: &PickerContext<'_>, _args: &[String], ) -> Result<PickerInitResult, String>

Build the candidate set. Sync prelude: read what’s needed from ctx, clone into async captures if necessary, return the appropriate PickerInitResult variant. Synchronous errors (no active buffer when one was required, args validation failure) return Err; the host echoes the error and leaves the picker closed.

fn accept( &self, _ctx: &PickerContext<'_>, routing: &RoutingPayload, ) -> Result<PickerAcceptOutcome, String>

Translate the user’s chosen routing payload into a typed PickerAcceptOutcome the host applies. The generator owns the mapping from its emitted routing-payload variant(s) to outcome(s); mismatch returns Err, which the host echoes.

fn accept_async( &self, _ctx: &PickerContext<'_>, _routing: &RoutingPayload, ) -> Option<Pin<Box<dyn Future<Output = Result<PickerAcceptOutcome, String>> + Send>>>

Async-accept hook. Default None means “this source resolves accept synchronously” — every native source takes this path and is unchanged.

fn on_query_changed( &self, _ctx: &PickerContext<'_>, _query: &str, ) -> Option<Result<PickerInitResult, String>>

Live-source hook: re-fetch candidates when the user’s query changes. Default None means “static source – host uses fuzzy refilter over the candidate set returned by init”. Returning Some(result) from a source whose spec().live == true replaces the picker’s candidate set wholesale; the host wires up debouncing and cancels any in-flight invocation when a fresh query arrives.

fn descend( &self, _ctx: &PickerContext<'_>, _candidate: &RawCandidate, ) -> Option<String>

PC.10: <C-l> — refine the query from the selected candidate instead of accepting it.

fn ascend(&self, _query: &str) -> Option<String>

PC.10: <C-w> (<C-h> until PH.1) — descend’s peer, one level out.

fn accept_navigates( &self, _ctx: &PickerContext<'_>, _candidate: &RawCandidate, ) -> Option<String>

PP.3: <CR> on a row that is a SIGNPOST rather than a destination.

fn initial_query(&self, _args: &[String]) -> Option<String>

PP.1: the query the picker opens WITH.

fn preview( &self, _ctx: &PickerContext<'_>, _routing: &RoutingPayload, ) -> Option<PickerPreviewOutcome>

T.12: live-preview hook — invoked as the picker SELECTION moves to a candidate (before accept). Default None = no preview. A source returns an outcome the host applies immediately for a live preview; the host restores prior state on .

fn preview_debounce(&self) -> Option<Duration>

MG.54: how long the selection must sit still before the host calls preview. None (the default) = call it inline on every selection move, which is right for a source whose preview is a cheap projection of data it already holds.

fn owner_plugin(&self) -> Option<u64>

PH.1: the host-issued id of the plugin that contributed this source, None for a native one.