Struct Key 

pub struct Key {

    pub name: String,
    pub ctrl: bool,
    pub meta: bool,
    pub shift: bool,
    pub sequence: String,
    pub raw: Option<String>,
    pub code: Option<String>,
    pub super_key: bool,
    pub hyper: bool,
    pub caps_lock: bool,
    pub num_lock: bool,
    pub event_type: Option<EventType>,
    pub is_kitty_protocol: bool,
    pub text: Option<String>,
    pub is_printable: Option<bool>,
}

A decoded key event, mirroring ink’s Key object (including kitty fields).

Fields

name: String

Resolved key name (e.g. "up", "a", "return", "number"). Empty when the sequence is unmapped.

ctrl: bool

meta: bool

shift: bool

sequence: String

The original sequence (decoded to text). Mirrors key.sequence.

raw: Option<String>

The raw sequence. None mirrors upstream’s raw: undefined cases.

code: Option<String>

Reassembled escape code for legacy fn-key sequences (key.code).

super_key: bool

hyper: bool

caps_lock: bool

num_lock: bool

event_type: Option<EventType>

Only set by the kitty protocol parser.

is_kitty_protocol: bool

true only for kitty-protocol keypresses.

text: Option<String>

Associated text input (kitty text-as-codepoints, or the default character for printable kitty keys).

is_printable: Option<bool>

Whether this key represents printable text input. Only set by the kitty protocol parser (None for legacy keys).

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl PartialEq for Key

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