Trait Command

Source

pub trait Command:
    Send
    + Sync
    + 'static {
    // Required methods
    fn id(&self) -> CommandId;
    fn description(&self) -> &'static str;

    // Provided methods
    fn args(&self) -> Vec<ArgSpec> { ... }
    fn names(&self) -> &[&'static str] { ... }
    fn complete(&self, _partial: &str) -> Vec<String> { ... }
    fn priority(&self) -> CommandPriority { ... }
}

Expand description

Self-describing command metadata.

Commands implement this trait to provide metadata about themselves:

Unique identifier (CommandId)
Human-readable description
Argument specifications
Command aliases (for ex commands like :w, :write)

§Design Philosophy

This trait separates command metadata from execution. The CommandHandler trait handles actual execution. This allows querying command information without executing.

§Example

use reovim_driver_command::{Command, ArgSpec, ArgKind};
use reovim_kernel::api::v1::{CommandId, ModuleId};

struct DeleteLine;

impl Command for DeleteLine {
    fn id(&self) -> CommandId {
        CommandId::new(ModuleId::new("editor"), "delete-line")
    }

    fn description(&self) -> &'static str {
        "Delete the current line"
    }

    fn args(&self) -> Vec<ArgSpec> {
        vec![ArgSpec::optional("count", ArgKind::Count, "Number of lines")]
    }
}