Struct CommandDefinition 

pub struct CommandDefinition {
    pub name: String,
    pub aliases: Vec<String>,
    pub description: String,
    pub required: bool,
    pub arguments: Vec<ArgumentDefinition>,
    pub options: Vec<OptionDefinition>,
    pub implementation: String,
}

Definition of a single command

Describes a command with its arguments, options, and validation rules. Each command must have a corresponding handler implementation.

Example

name: simulate
aliases: [sim, run]
description: "Run a simulation"
required: true
arguments:
  - name: input_file
    arg_type: path
    required: true
    description: "Input configuration file"
    validation:
      - must_exist: true
      - extensions: [yaml, json]
options: []
implementation: "simulate_handler"

Fields

name: String

Command name (used for invocation)

aliases: Vec<String>

Alternative names for the command

description: String

Human-readable description for help text

required: bool

Whether this command is required to be implemented

If true, the application will fail to start if no handler is registered.

arguments: Vec<ArgumentDefinition>

Positional arguments

options: Vec<OptionDefinition>

Named options (flags)

implementation: String

Name of the handler implementation

This string is used to match the command with its registered handler in the CommandRegistry.

Trait Implementations

impl Clone for CommandDefinition

fn clone(&self) -> CommandDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandDefinition

fn eq(&self, other: &CommandDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommandDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandDefinition