Struct HelpConfig 

pub struct HelpConfig {
    pub default_scope: HelpScope,
    pub default_format: HelpFormat,
}

Configuration for pre-clap help handling.

The handler scans raw argv before Cli::try_parse() so applications can support requests such as --help --output markdown without clap exiting early with DisplayHelp.

Requires the cli-help feature.

Fields

default_scope: HelpScope

Scope used for --help / -h when --recursive is absent.

default_format: HelpFormat

Format used for help when no explicit --output is present.

Implementations

impl HelpConfig

pub const fn human_cli_default() -> Self

The blessed preset for CLIs.

--help renders one-level plain help by default. Scope and format are orthogonal: --recursive expands the selected command subtree, while --output json|yaml|markdown picks the format. So --help --recursive is recursive plain text and --help --recursive --output markdown is a recursive Markdown export.

Trait Implementations

impl Clone for HelpConfig

fn clone(&self) -> HelpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpConfig

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

Formats the value using the given formatter.

impl Eq for HelpConfig

impl PartialEq for HelpConfig

fn eq(&self, other: &HelpConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HelpConfig