Struct CommandSpec 

pub struct CommandSpec {
    pub id: CommandId,
    pub name: String,
    pub kind: CommandKind,
    pub doc: String,
    pub args_schema: Vec<ArgSpec>,
    pub source: SourceLocation,
    pub latency_class: LatencyClass,
}

Metadata + the actual implementation of a registered command. Stored in the CommandRegistry.

Fields

id: CommandId

The id the registry minted at registration; unique per process.

name: String

The canonical, namespaced name (motion:word-forward, operator:delete, ex:write, action:…). The key for CommandRegistry::id_by_name; user-typed aliases are resolved to it by the front-end.

kind: CommandKind

Which dispatcher path handles it.

doc: String

The help text shown by :describe-command, :apropos and completion.

args_schema: Vec<ArgSpec>

Per-positional-argument metadata (DESIGN.md §B.1). Lifted from the per-kind spec (MotionSpec.args_schema, ExCommandSpec.args_schema, …) at registration time so callers can introspect arg shape without knowing the registration kind. Used by :describe-command, palette form rendering, and missing- arg prompts.

source: SourceLocation

Where this command was registered (DESIGN.md §5.11). Captured via #[track_caller] for built-ins, by the plugin host for plugin-registered commands, by the config loader for user-registered commands. The field is pub for read access (introspection), but the only writers are the trusted pub(crate) insert_* registry methods – there is no public API that takes a SourceLocation parameter.

latency_class: LatencyClass

Latency class declaration (DESIGN.md §5.2.5). Surfaced by :describe-command; future cancellation / deadline machinery reads this to set per-call budgets. v1 is purely declarative – no runtime enforcement yet.

Trait Implementations

impl Clone for CommandSpec

fn clone(&self) -> CommandSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSpec

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

Formats the value using the given formatter.

impl Introspectable for CommandSpec

fn kind_label(&self) -> &'static str

Kind label for the help-buffer heading: "command", "key", "option", "event", "mode", "buffer".

fn identifier(&self) -> String

User-facing identifier: "ex:write", "j", "editor.line-numbers".

fn doc(&self) -> &str

Multi-line documentation. May be empty (the renderer prints a (no documentation) placeholder).

fn sources(&self) -> Vec<SourceEntry<'_>>

One or more provenance entries. Empty means “no recorded origin” (common for synthesised buffers / runtime values without a trace).

fn extra_sections(&self) -> Vec<HelpSection>

Type-specific blocks: args list for commands, mode-grouped bindings for keys, value/type for options, payload for events, keymap chain for modes. Default empty.