Enum broot::command::Command

source · [−]

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),
}

Expand description

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 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Command

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

Formats the value using the given formatter. Read more

impl Default for Command

fn default() -> Command

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Command

impl Send for Command

impl Sync for Command

impl Unpin for Command

impl UnwindSafe for Command

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.