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 when --recursive is absent.

default_format: HelpFormat

Fallback format when the command has no valid default for --output.

An explicit --output always wins. When it is omitted, the handler first inherits the command’s own --output default so help follows the same output contract as every other successful result.

Implementations

impl HelpConfig

pub const fn output_aware() -> Self

The blessed preset for CLIs.

--help renders one-level help and inherits the command’s own --output default. Scope and format are orthogonal: --recursive expands the selected command subtree, while --output plain|json|yaml|markdown picks the format. Plain is only the fallback for commands that do not declare a supported --output default.

pub const fn output_aware_with_fallback(default_format: HelpFormat) -> Self

Output-aware help with an explicit fallback format.

Use this for a fixed-format CLI that has no --output argument. For example, a CLI whose normal output is always protocol JSON should pass HelpFormat::Json. An explicit help --output, or a supported default declared by the selected command or an ancestor, still wins.

pub const fn human_cli_default() -> Self

Compatibility alias for Self::output_aware.

The historical name predates output-default inheritance and is less precise: a JSON-default command receives JSON help, not human text.

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