Struct HelpInfo 

pub struct HelpInfo {
    pub description: &'static str,
    pub positionals: &'static [OptionArgInfo],
    pub options: &'static [OptionArgInfo],
    pub commands: Option<CommandsHelpInfo>,
    pub footer: &'static str,
}

Information about a specific (sub)command used for generating a help message.

Fields

description: &'static str

positionals: &'static [OptionArgInfo]

options: &'static [OptionArgInfo]

commands: Option<CommandsHelpInfo>

footer: &'static str

Implementations

impl HelpInfo

pub const fn help( &'static self, command_name: String, global_options: Vec<&'static OptionArgInfo>, ) -> Help

Creates a new Help generator instance.

• command_name: The identifier for the current command.
• global_options: Information about additional global options (from ancestors) to add to the generated help message.

Trait Implementations

impl Debug for HelpInfo

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

Formats the value using the given formatter.