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

A wrapper to format the help message with custom parameters.

Constructed through Help::format.

Implementations

Configure the width to use for help text.

Configure the padding to use when formatting help.

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

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.