Struct Command 

pub struct Command {
    pub id: String,
    pub label: String,
    pub category: String,
    pub keys: Vec<Key>,
    pub context: Option<String>,
    pub sequence: bool,
    pub unavailable: Option<String>,
}

Something the Palette offers: a binding of the keymap (from_binding) or a command of yours.

Fields

id: String

What identifies it: context.action for a binding.

label: String

What it does, for people.

category: String

The group it is listed under: a binding’s context.

keys: Vec<Key>

The keys that run it, shown as its shortcut; the first runs it under Overlays when it has no handler.

context: Option<String>

The context it belongs to: listed only while that context is active (Palette::contexts). None: always listed.

sequence: bool

Its keys are pressed one after another (g g), not alternatives.

unavailable: Option<String>

Why it cannot run now: listed greyed with the reason, and Enter or a click on it does nothing.

Implementations

impl Command

pub fn new(id: impl Into<String>, label: impl Into<String>) -> Command

pub fn category(self, category: impl Into<String>) -> Self

pub fn keys(self, keys: impl IntoIterator<Item = Key>) -> Self

Its shortcut, when the keymap does not say (see Palette::hints).

pub fn context(self, context: impl Into<String>) -> Self

List it only while context is active.

pub fn unavailable(self, reason: impl Into<String>) -> Self

List it greyed, saying reason, and do not run it.

pub fn from_binding(binding: &Binding) -> Command

The command a binding makes: its description, under its context, with its keys.

pub fn keys_label(&self) -> String

The keys as a hint shows them: ↑/ctrl+p, or g g for a sequence.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

Returns a duplicate 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 Eq for Command

impl PartialEq for Command

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Command