Struct Help 

pub struct Help {
    pub key: String,
    pub desc: String,
}

Help information for displaying keybinding documentation.

This structure contains the human-readable representation of a key binding that will be shown in help views and documentation.

Examples

use bubbletea_widgets::key::Help;

let help = Help {
    key: "ctrl+s".to_string(),
    desc: "Save file".to_string(),
};

Fields

key: String

The human-readable representation of the key combination (e.g., “ctrl+s”, “enter”).

desc: String

A brief description of what the key binding does.

Trait Implementations

impl Clone for Help

fn clone(&self) -> Help

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Help

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

Formats the value using the given formatter.

impl Default for Help

fn default() -> Help

Returns the “default value” for a type.

impl PartialEq for Help

fn eq(&self, other: &Help) -> 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 Help

impl StructuralPartialEq for Help