Struct KeyBinding 

pub struct KeyBinding {
    pub key: String,
    pub modifiers: KeyModifiers,
}

A key binding (key + modifiers).

Fields

key: String

modifiers: KeyModifiers

Implementations

impl KeyBinding

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

Create a new key binding.

pub fn plain(key: impl Into<String>) -> Self

Create a key binding with no modifiers.

pub fn ctrl(key: impl Into<String>) -> Self

Create a key binding with ctrl modifier.

pub fn alt(key: impl Into<String>) -> Self

Create a key binding with alt modifier.

pub fn shift(key: impl Into<String>) -> Self

Create a key binding with shift modifier.

pub fn ctrl_shift(key: impl Into<String>) -> Self

Create a key binding with ctrl+shift modifiers.

pub fn ctrl_alt(key: impl Into<String>) -> Self

Create a key binding with ctrl+alt modifiers.

pub fn from_bubbletea_key(key: &KeyMsg) -> Option<Self>

Convert a bubbletea KeyMsg to a KeyBinding for lookup.

Returns None for paste events or multi-character input that cannot map to a single key binding.

Trait Implementations

impl Clone for KeyBinding

fn clone(&self) -> KeyBinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBinding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyBinding

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyBinding

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

Formats the value using the given formatter.

impl FromStr for KeyBinding

type Err = KeyBindingParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KeyBinding

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 KeyBinding

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyBinding

impl StructuralPartialEq for KeyBinding