Struct HelpInfo 

pub struct HelpInfo {
    pub name: String,
    pub version: Option<String>,
    pub about: Option<String>,
    pub description: Option<String>,
    pub usage: Option<String>,
    pub groups: Vec<ArgGroup>,
    pub commands: Vec<CommandInfo>,
    pub examples: Vec<(String, String)>,
    pub author: Option<String>,
    pub notes: Vec<String>,
}

Help information for display.

Fields

name: String

Program name.

version: Option<String>

Program version.

about: Option<String>

Short description.

description: Option<String>

Longer description.

usage: Option<String>

Usage string.

groups: Vec<ArgGroup>

Argument groups.

commands: Vec<CommandInfo>

Subcommands.

examples: Vec<(String, String)>

Examples.

author: Option<String>

Author information.

notes: Vec<String>

Additional notes.

Implementations

impl HelpInfo

pub fn new(name: impl Into<String>) -> Self

Create new help info.

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

Set version.

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

Set about text.

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

Set description.

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

Set usage string.

pub fn group(self, group: ArgGroup) -> Self

Add an argument group.

pub fn command(self, cmd: CommandInfo) -> Self

Add a command.

pub fn example(self, cmd: impl Into<String>, desc: impl Into<String>) -> Self

Add an example.

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

Set author.

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

Add a note.

Trait Implementations

impl Clone for HelpInfo

fn clone(&self) -> HelpInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpInfo

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

Formats the value using the given formatter.