Skip to main content

HelpRenderer

Type Alias HelpRenderer 

Source
pub type HelpRenderer = Arc<dyn Fn(&dyn CommandLike, &Context) -> String + Send + Sync>;
Expand description

A pluggable help renderer that can be installed into a context.

When present, Group::invoke calls this instead of cmd.get_help() whenever a subcommand’s --help is requested (i.e. Exit{0} during make_context).

The function receives the command-like object and a Context whose info_name is set to the full command path ("cli subcommand"), matching the context that get_help would receive in normal flow.

Installed by ContextBuilder::help_renderer; inherited through the parent chain by Context::help_renderer.

Aliased Type§

pub struct HelpRenderer { /* private fields */ }