Struct CommandSpec 

pub struct CommandSpec {
    pub command_path: Vec<String>,
    pub about: Option<String>,
    pub reference_note: Option<String>,
    pub arguments: Vec<ArgSpec>,
    pub combinations: Vec<Combination>,
}

One exact command path in a CLI registry.

Fields

command_path: Vec<String>

about: Option<String>

reference_note: Option<String>

Prose for the generated reference, after this command’s argument table.

An argument’s about is one table cell and has to stay one — but some commands need a paragraph that belongs to no single argument: where a default is read from, what two options mean together, what the result reports back. Without somewhere to put it, that paragraph ends up hand-written into a file whose own header says “generated, do not edit by hand”, where the next regeneration silently deletes it.

Reference only. --help stays the machine-readable shape of a command; this is for the document a person reads.

arguments: Vec<ArgSpec>

combinations: Vec<Combination>

Implementations

impl CommandSpec

pub fn root() -> Self

pub fn new<I, S>(command_path: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

pub fn about(self, about: impl Into<String>) -> Self

pub fn reference_note(self, note: impl Into<String>) -> Self

Prose for the generated reference, after this command’s argument table.

pub fn arg(self, argument: ArgSpec) -> Self

pub fn combination(self, combination: Combination) -> Self

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<'de> Deserialize<'de> for CommandSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommandSpec

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 CommandSpec