Skip to main content

Command

Struct Command 

Source
pub struct Command {
    pub name: &'static str,
    pub args: &'static str,
    pub summary: &'static str,
    pub agent_facing: bool,
    pub group: &'static str,
}
Expand description

One choir subcommand.

Fields§

§name: &'static str

Subcommand name.

§args: &'static str

Argument spec as shown in help, e.g. <api> <key-file>.

§summary: &'static str

One line, imperative, no trailing period.

§agent_facing: bool

Whether an agent is expected to reach for this routinely.

§group: &'static str

Which section of --help this belongs under.

Help used to be one flat list of every command in the order they were added, which is the order they were written rather than any order they are read in. Thirty-two lines like that is a wall, and the reader’s actual question — “what do I run to get a change reviewed” — was answered nowhere on the page.

A field rather than a lookup table beside the list, so a new command cannot be added without deciding where it belongs; the compiler asks.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.