[−][src]Struct argwerk::Help
Helper that can be formatted into documentation text.
Fields
usage: &'static str
The verbatim usage summary specified when invoking the macro.
docs: &'static [&'static str]
Documentation comments associated with the command.
switches: &'static [Switch]
Switches associated with the command.
Implementations
impl Help
[src]
pub fn format(&self) -> HelpFormat<'_>
[src]
Format the help with the given config.
Examples
argwerk::define! { /// A simple test command. #[usage = "command [-h]"] struct Args { help: bool, } /// Prints the help. /// /// This includes: /// * All the available switches. /// * All the available positional arguments. /// * Whatever else the developer decided to put in here! We even support wrapping comments which are overly long. ["-h" | "--help"] => { help = true; } } let formatted = format!("{}", Args::help().format().width(120)); assert!(formatted.split('\n').any(|line| line.len() > 80)); assert!(formatted.split('\n').all(|line| line.len() < 120));
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Help
[src]
impl Send for Help
[src]
impl Sync for Help
[src]
impl Unpin for Help
[src]
impl UnwindSafe for Help
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,