Struct CliRoute 

pub struct CliRoute {
    pub path: &'static [&'static str],
    pub verb: &'static str,
    pub args: &'static [CliArg],
    pub examples: &'static [CliExample],
}

Where a command sits in the command line, and how it presents itself.

Opt-in by construction: a command joins the command line only by declaring one, so internal plumbing cannot reach an agent- or human-facing surface by being written.

path is a slice rather than a single noun because flat command names hide a hierarchy: list_session_participants is sessions participants list. Deriving that by string surgery is wrong for exactly the irregular names that matter, so the shape is declared.

Fields

path: &'static [&'static str]

Noun path from the root, e.g. ["agents"] or ["agents", "versions"].

verb: &'static str

Leaf verb, e.g. "list".

args: &'static [CliArg]

Presentation for the parameters that need more than the default.

examples: &'static [CliExample]

Worked examples, rendered under the command’s help.

Implementations

impl CliRoute

pub const fn new(path: &'static [&'static str], verb: &'static str) -> Self

pub const fn with_args(self, args: &'static [CliArg]) -> Self

pub const fn with_examples(self, examples: &'static [CliExample]) -> Self

pub fn spelling(&self) -> String

Space-joined spelling, e.g. "agents versions list".

pub fn arg(&self, field: &str) -> Option<&CliArg>

The declaration for one parameter, if it has one.

Trait Implementations

impl Clone for CliRoute

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CliRoute

impl Debug for CliRoute

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

Formats the value using the given formatter.

impl Eq for CliRoute

impl PartialEq for CliRoute

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CliRoute