Struct argwerk::HelpFormat
source · [−]pub struct HelpFormat<'a> { /* private fields */ }Expand description
A wrapper to format the help message with custom parameters.
Constructed through Help::format.
Implementations
sourceimpl HelpFormat<'_>
impl HelpFormat<'_>
sourcepub fn padding(self, padding: usize) -> Self
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.
sourcepub fn max_usage(self, max_usage: usize) -> Self
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
Auto Trait Implementations
impl<'a> RefUnwindSafe for HelpFormat<'a>
impl<'a> Send for HelpFormat<'a>
impl<'a> Sync for HelpFormat<'a>
impl<'a> Unpin for HelpFormat<'a>
impl<'a> UnwindSafe for HelpFormat<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more