Struct Binding 

pub struct Binding {
    pub context: String,
    pub action: String,
    pub keys: Vec<Key>,
    pub description: String,
    pub sequence: bool,
    pub unavailable: Option<String>,
}

One thing a key does: an action, in a context, with a description.

Fields

context: String

Which component or container it belongs to: select, split.

action: String

What it does, for code and configuration: down, focus-next.

keys: Vec<Key>

The keys that do it, first the one to show.

description: String

What it does, for people: move down.

sequence: bool

The keys are pressed one after another (g g), rather than being alternatives: a key sequence an app runs itself, listed in a help or a palette. A keymap does not look these up.

unavailable: Option<String>

Why it cannot be done now, when it cannot: a help or a palette lists it greyed, with the reason, and a palette does not run it.

Implementations

impl Binding

pub fn new( context: impl Into<String>, action: impl Into<String>, keys: impl IntoIterator<Item = Key>, description: impl Into<String>, ) -> Binding

pub fn sequence( context: impl Into<String>, action: impl Into<String>, keys: impl IntoIterator<Item = Key>, description: impl Into<String>, ) -> Binding

A binding of keys pressed one after another (g then g), for a help or a palette to list: shown as g g.

use rich_interact::keymap::{keys, Binding};

let top = Binding::sequence("files", "top", keys("g g"), "go to the top");
assert_eq!(top.keys_label(), "g g");

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

Listed but not available now, saying reason (see unavailable).

use rich_interact::keymap::{keys, Binding};

let save = Binding::new("editor", "save", keys("ctrl+s"), "save").unavailable("read-only");
assert_eq!(save.unavailable.as_deref(), Some("read-only"));

pub fn id(&self) -> String

context.action: how configuration names it.

pub fn keys_label(&self) -> String

The keys as people read them: up/ctrl+p, or g g for a sequence.

pub fn hint(&self) -> String

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

Trait Implementations

impl Clone for Binding

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 Binding

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

Formats the value using the given formatter.

impl Display for Binding

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

Formats the value using the given formatter.

impl Eq for Binding

impl PartialEq for Binding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Binding