Struct HelpEntry 

pub struct HelpEntry {
    pub key: String,
    pub desc: String,
    pub enabled: bool,
    pub category: HelpCategory,
}

A single keybinding entry in the help view.

Fields

key: String

The key or key combination (e.g. “^C”, “↑/k”).

desc: String

Description of what the key does.

enabled: bool

Whether this entry is enabled (disabled entries are hidden).

category: HelpCategory

Category for grouping related entries.

Implementations

impl HelpEntry

pub fn new(key: impl Into<String>, desc: impl Into<String>) -> Self

Create a new enabled help entry.

pub fn with_enabled(self, enabled: bool) -> Self

Set whether this entry is enabled.

pub fn with_category(self, category: HelpCategory) -> Self

Set the category for this entry.

Trait Implementations

impl Clone for HelpEntry

fn clone(&self) -> HelpEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpEntry

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

Formats the value using the given formatter.

impl PartialEq for HelpEntry

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HelpEntry

impl StructuralPartialEq for HelpEntry