Enum broot::command::Command

pub enum Command {
    None,
    VerbEdit(VerbInvocation),
    VerbInvocate(VerbInvocation),
    Internal {
        internal: Internal,
        input_invocation: Option<VerbInvocation>,
    },
    VerbTrigger {
        index: usize,
        input_invocation: Option<VerbInvocation>,
    },
    PatternEdit {
        raw: String,
        expr: BeTree<PatternOperator, PatternParts>,
    },
    Click(u16, u16),
    DoubleClick(u16, u16),
}

a command which may result in a change in the application state.

It may come from a shortcut, from the parsed input, from an argument given on launch.

Variants

None

no command

VerbEdit(VerbInvocation)

a verb invocation, unfinished (user didn’t hit enter)

VerbInvocate(VerbInvocation)

verb invocation, finished (coming from –cmd, or after the user hit enter)

Internal

Fields

internal: Internal

input_invocation: Option<VerbInvocation>

call of an internal done without the input (using a trigger key for example)

VerbTrigger

Fields

index: usize

input_invocation: Option<VerbInvocation>

call of a verb done without the input (using a trigger key for example)

PatternEdit

Fields

raw: String

expr: BeTree<PatternOperator, PatternParts>

a pattern being edited

Click(u16, u16)

a mouse click

DoubleClick(u16, u16)

a mouse double-click Always come after a simple click at same position

Implementations

impl Command

pub fn empty() -> Command

pub fn as_verb_invocation(&self) -> Option<&VerbInvocation>

pub fn from_parts(cp: CommandParts, finished: bool) -> Self

build a command from the parsed string representation

The command being finished is the difference between a command being edited and a command launched (which happens on enter in the input).

pub fn is_verb_invocated_from_input(&self) -> bool

tells whether this action is a verb being invocated on enter in the input field

pub fn from_raw(raw: String, finished: bool) -> Self

create a command from a raw input.

finished makes the command an executed form, it’s equivalent to using the Enter key in the Gui.

pub fn from_pattern(pattern: &InputPattern) -> Self

build a non executed command from a pattern

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Command

Returns the “default value” for a type.