Struct CommandSchema 

pub struct CommandSchema {
    pub name: String,
    pub description: String,
    pub options: Vec<CLOption>,
    pub arguments: Vec<CLArgument>,
    pub subcommands: Vec<CommandSchema>,
}

Schema for a command (root or subcommand). Build with the fluent API or construct the struct literally for tests.

Fields

name: String

description: String

options: Vec<CLOption>

arguments: Vec<CLArgument>

subcommands: Vec<CommandSchema>

Implementations

impl CommandSchema

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Self

pub fn flag(self, prefix: &str, description: &str) -> Self

Add a boolean flag.

pub fn option(self, prefix: &str, description: &str) -> Self

Add a value-consuming option.

pub fn option_named( self, prefix: &str, value_name: &str, description: &str, ) -> Self

Add a value-consuming option with a custom placeholder shown in help.

pub fn argument(self, name: &str, description: &str) -> Self

Add a required positional argument.

pub fn optional_argument(self, name: &str, description: &str) -> Self

Add an optional positional argument.

pub fn subcommand(self, schema: CommandSchema) -> Self

Register a subcommand schema.

Trait Implementations

impl Clone for CommandSchema

fn clone(&self) -> CommandSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandSchema

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

Formats the value using the given formatter.