Struct printr::app::CustomArg

pub struct CustomArg {
    pub name: &'static str,
    pub doc_short: &'static str,
    pub doc_long: &'static str,
    pub hidden: bool,
    pub kind: CustomArgKind,
    // some fields omitted
}

This is a custom type which acts a wrapper around clap’s Arg struct and adds some extended custom functionality.

Fields

name: &'static str

The name of this argument. This is always present and is the name used in the code to find the value of an argument at runtime.

doc_short: &'static str

A short documentation string describing this argument. This string should fit on a single line and be a complete sentence.

This is shown in the -h output.

doc_long: &'static str

A longer documentation string describing this argument. This usually starts with the contents of doc_short. This is also usually many lines, potentially paragraphs, and may contain examples and additional prose.

This is shown in the --help output.

Generally, these flags should be documented in the documentation for the flag they override.

hidden: bool

Whether this flag is hidden or not.

kind: CustomArgKind

The type of this argument.