Struct argwerk::HelpFormat

pub struct HelpFormat<'a> { /* private fields */ }

A wrapper to format the help message with custom parameters.

Constructed through Help::format.

Implementations

impl HelpFormat<'_>

pub fn width(self, width: usize) -> Self

Configure the width to use for help text.

pub fn padding(self, padding: usize) -> Self

Configure the padding to use when formatting help.

This determines the indentation of options and the distances between options and help text.

pub fn max_usage(self, max_usage: usize) -> Self

Configure the max usage width to use when formatting help.

This determines how wide a usage help is allowed to be before it forces the associated documentation to flow to the next line.

Usage help is the --file, -f <path> part of each switch and argument.

Trait Implementations

impl<'a> Display for HelpFormat<'a>

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

Formats the value using the given formatter.