Struct KeyEvent 

pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: KeyModifiers,
}

SDK-facing key event DTO.

KeyEvent is intentionally inert: constructing one does not arm a detector, push a frame, or open a daemon connection. SDK consumers build these from their own keyboard source (or via the optional crossterm feature) and feed them into helpers like DetachDetector::feed.

Fields

code: KeyCode

Logical key code.

modifiers: KeyModifiers

Active modifier flags when the key was reported.

Implementations

impl KeyEvent

pub const fn new(code: KeyCode, modifiers: KeyModifiers) -> Self

Constructs an event from a code and modifier set.

pub const fn bare(code: KeyCode) -> Self

Constructs a modifier-free event from a code.

pub const fn ctrl(ch: char) -> Self

Constructs a Ctrl+-modified character event.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyEvent

impl Hash for KeyEvent

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 KeyEvent

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyEvent