Struct Keybind 

pub struct Keybind {
    pub key: KeyCode,
    pub modifiers: Modifiers,
    pub description: &'static str,
}

A keyboard shortcut definition.

Fields

key: KeyCode

The key that triggers this keybind.

modifiers: Modifiers

Required modifier keys.

description: &'static str

Human-readable description of what this keybind does.

Implementations

impl Keybind

pub fn new( key: KeyCode, modifiers: Modifiers, description: &'static str, ) -> Self

Create a new keybind.

pub fn key(key: KeyCode, description: &'static str) -> Self

Create a keybind with no modifiers.

pub fn ctrl(key: KeyCode, description: &'static str) -> Self

Create a keybind with Ctrl modifier.

pub fn shift(key: KeyCode, description: &'static str) -> Self

Create a keybind with Shift modifier.

pub fn ctrl_shift(key: KeyCode, description: &'static str) -> Self

Create a keybind with Ctrl+Shift modifiers.

pub fn matches(&self, key: KeyCode, modifiers: Modifiers) -> bool

Check if this keybind matches the given key and modifiers.

pub fn to_string_short(&self) -> String

Format this keybind as a human-readable string.

Trait Implementations

impl Clone for Keybind

fn clone(&self) -> Keybind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keybind

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

Formats the value using the given formatter.

impl Hash for Keybind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Keybind

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

impl StructuralPartialEq for Keybind