Struct Key 

pub struct Key {
    pub keys: &'static str,
    pub label: &'static str,
    pub also: &'static [&'static str],
    pub line: &'static str,
    pub more: Option<&'static str>,
    pub run: Run,
}

One key, or a few that do one thing in turn (n / N).

Fields

keys: &'static str

What is typed, as the help writes it: ↑ / ↓ (j/k), Ctrl+O, (type).

label: &'static str

A word or two for a hint beside the key: Filter, Next match.

also: &'static [&'static str]

Other words a hint may give the key where what it does turns on the screen’s state: Enter’s Show rows beside Read rows. A hint says one of these or Key::label, never a word of its own.

line: &'static str

One line: the in-app help, and the man page and docs without Key::more.

more: Option<&'static str>

The whole description, where it says more than the line: the manpage and the docs print it in place of the line.

run: Run

Implementations

impl Key

pub const fn more(self, more: &'static str) -> Self

With the whole description for the manpage and the docs.

pub const fn also(self, also: &'static [&'static str]) -> Self

With other words a hint may say for it; see Key::also.

pub fn says(&self, label: &str) -> bool

Whether a hint may give this key label.

pub const fn run(self, spec: &'static str) -> Self

Enter in the help presses spec rather than the first key.

pub const fn no_run(self) -> Self

Enter in the help presses nothing for this entry.

pub fn long(&self) -> &'static str

The description the manpage and the docs print.

pub fn action(&self) -> Option<Chord>

The key Enter on this line presses, if any.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Key