Struct broot::verb::InvocationParser
source · pub struct InvocationParser {
pub invocation_pattern: VerbInvocation,
pub arg_defs: Vec<ArgDef>,
/* private fields */
}
Expand description
Definition of how the user input should be checked and maybe parsed to provide the arguments used for execution or description.
Fields§
§invocation_pattern: VerbInvocation
pattern of how the command is supposed to be typed in the input
arg_defs: Vec<ArgDef>
Implementations§
source§impl InvocationParser
impl InvocationParser
pub fn new(invocation_str: &str) -> Result<Self, ConfError>
pub fn name(&self) -> &str
pub fn get_unique_arg_def(&self) -> Option<ArgDef>
pub fn get_unique_arg_anchor(&self) -> PathAnchor
sourcepub fn check_args(
&self,
invocation: &VerbInvocation,
_other_path: &Option<PathBuf>
) -> Option<String>
pub fn check_args( &self, invocation: &VerbInvocation, _other_path: &Option<PathBuf> ) -> Option<String>
Assuming the verb has been matched, check whether the arguments are OK according to the regex. Return none when there’s no problem and return the error to display if arguments don’t match
pub fn parse(&self, args: &str) -> Option<AHashMap<String, String>>
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for InvocationParser
impl Send for InvocationParser
impl Sync for InvocationParser
impl Unpin for InvocationParser
impl UnwindSafe for InvocationParser
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more