Struct KeyPress 

pub struct KeyPress {
    pub key: Key,
    pub modifiers: KeyModifiers,
}

A key press event: a key combined with modifier state.

Parses combo strings like "Ctrl+s", "Shift + Enter", "Ctrl+Shift+ArrowUp". Also converts from a bare Key (no modifiers) or a (Key, KeyModifiers) tuple.

Fields

key: Key

Key.

modifiers: KeyModifiers

Active modifier keys.

Implementations

impl KeyPress

pub fn new(key: Key, modifiers: KeyModifiers) -> Self

Construct a new value.

pub fn from_wire(payload: &Value) -> Option<Self>

Parse from the wire protocol payload.

Accepts three formats:

• Combined: {"combo": "Ctrl+s"} (preferred)
• Explicit: {"key": "s", "modifiers": {"ctrl": true}}
• Legacy combined: {"key": "ctrl+s"} (key field contains combo)

Trait Implementations

impl Clone for KeyPress

fn clone(&self) -> KeyPress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPress

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

Formats the value using the given formatter.

impl Display for KeyPress

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

Formats the value using the given formatter.

impl From<&str> for KeyPress

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<(Key, KeyModifiers)> for KeyPress

fn from((key, modifiers): (Key, KeyModifiers)) -> Self

Converts to this type from the input type.

impl From<Key> for KeyPress

fn from(key: Key) -> Self

Converts to this type from the input type.

impl From<String> for KeyPress

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for KeyPress

type Err = ParseKeyPressError

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 PartialEq for KeyPress

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

impl StructuralPartialEq for KeyPress