Struct HelpPrinter 

pub struct HelpPrinter;

Format help output for a schema. The result is ANSI-styled when the destination stream is a TTY and plain otherwise.

Implementations

impl HelpPrinter

pub fn format(schema: &CommandSchema) -> String

Produce help text sized for stderr (color when stderr is a TTY). Prefer HelpPrinter::print / HelpPrinter::print_error in production; this method is primarily here for tests.

pub fn print(schema: &CommandSchema)

Print help text to stdout. Use this for user-requested help (--help) so output can be piped or redirected normally. Color is keyed off stdout, so redirected stdout is always plain. Flushes stdout before returning so callers that process::exit immediately afterwards still see all bytes land.

pub fn print_error(schema: &CommandSchema)

Print help text to stderr. Use this alongside an error message so both are grouped on the same stream.