Struct broot::verb::InvocationParser

pub struct InvocationParser {
    pub invocation_pattern: VerbInvocation,
    pub arg_anchor: PathAnchor,
    pub arg_selection_type: Option<SelectionType>,
    // some fields omitted
}

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_anchor: PathAnchor

whether the path, when non absolute, should be interpreted as relative to the closest directory (which may be the selection) or to the parent of the selection

arg_selection_type: Option<SelectionType>

contain the type of selection in case there's only one arg and it's a path (when it's not None, the user can type ctrl-P to select the argument in another panel)

Implementations

impl InvocationParser

pub fn new(invocation_str: &str) -> Result<Self, ConfError>

pub fn name(&self) -> &str

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<FnvHashMap<String, String>>

Trait Implementations

impl Debug for InvocationParser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.