Struct Global 

pub struct Global {
    pub id: &'static str,
    pub name: &'static str,
    pub summary: &'static str,
    pub description: &'static str,
}

One global flag, as the first screen prints it and as a verb page prints it.

The summary and the description are declared together, at the flag, which is what #321 clause 5 asks of a short form: a summary written a second time somewhere else is the second copy of a description that #257 was filed about. The table is here rather than in headwater-verbs, where headwater_verbs::Verb declares the same pair for a verb, because HW-DR-0033 rules that a flag belongs to the verb that reads it and that its description is written at the declaration of that flag. A global flag is declared in this file, so its summary is too.

HW-DR-0042 holds summary to one line of the first screen, and engine/crates/cli/tests/help.rs is what holds it.

Fields

id: &'static str

The identifier clap knows the argument by.

The entry is bound to the flag by this rather than by a name that resembles it, so a flag that arrives with no entry is reported against the identifier a reader of the parser will recognize.

name: &'static str

The flag as the first screen names it: every spelling, and any value.

summary: &'static str

One line of the first screen, for a reader who is choosing a verb.

description: &'static str

The whole of it, which is what clap carries onto every verb page.

Implementations

impl Global

pub fn covers(&self, id: &str) -> bool

Whether this entry is the entry of the argument clap calls id.

Trait Implementations

impl Debug for Global

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

Formats the value using the given formatter.