Struct quartz_commands::Help

pub struct Help<'a> {
    pub verbatim: &'a str,
}

A wrapper around arguments which could be interpreted as the user asking for help with a command. This wrapper will match on help, and h prefixed by zero, one, or two hyphens.

Fields

verbatim: &'a str

The exact string the user typed.

Implementations

impl<'a> Help<'a>

pub fn suggestions() -> impl IntoIterator<Item = &'static str>

Returns the singleton "-help".

Trait Implementations

impl<'a, C> FromArgument<'a, C> for Help<'a>

fn matches(arg: &str) -> bool

Returns whether or not the given argument matches the format of Self. Returning true does not imply that from_arg will succeed, but it does imply that the argument could succeed given the correct context. In other words, this function should return true for any input that is in the set of all possible string representations of Self given all possible contexts. If Self is represented by multiple arguments, then this function should return true if the first of those arguments is valid.

fn partial_matches(partial_arg: &str) -> bool

This function follows similar rules to matches, however it is not guaranteed that a full argument will be given to this function. This test is primarily used in suggestion generation while the user is part-way through typing an argument, and hence should return true whenever matches returns true, and should also return true for every truncation of every input for which matches returns true.

fn from_arg(
    arg: &'a str,
    _args: &mut ArgumentTraverser<'a>,
    _context: &C
) -> Result<Self, Error>

Parses the given argument given a context. This function should only fail if it is impossible to construct a valid Self from the given string, traverser, and context. Any logical checks should be performed in execution blocks.