Struct EventKey 

pub struct EventKey {
    pub semantic: Key,
    pub physical: Key,
    pub mods: KeyMods,
    pub state: KeyState,
}

Available on crate feature event only.

🎫 🎮 Represents a keyboard event.

---

^{📍 ui/event}

^{📦 size_of::<EventKey>() == 20 bytes / 160 bits ⚗️Option<T>}

---

See also EventKeyFfi.

Fields

semantic: Key

The key representing the human-readable code.

This corresponds to X11’s keysym.

physical: Key

The key representing the hardware scan code.

This corresponds to X11’s scancode XKB mapped.

mods: KeyMods

The active modifiers of the key (e.g., Shift, Ctrl).

state: KeyState

The state of the key (pressed or released).

Implementations

impl EventKey

pub const fn to_ffi(&self) -> EventKeyFfi

Available on ffi·· only.

Converts EventKey to EventKeyFfi.

pub const fn from_ffi(from: &EventKeyFfi) -> EventKey

Available on ffi·· only.

Converts EventKeyFfi to EventKey.

impl EventKey

pub const fn new( semantic: Key, physical: Key, mods: KeyMods, state: KeyState, ) -> Self

Creates a key event from fully specified fields.

pub const fn press(key: Key) -> Self

Creates a key press whose semantic and physical keys are the same.

pub const fn modified_press(key: Key, mods: KeyMods) -> Self

Creates a modified key press whose semantic and physical keys are the same.

pub const fn text(c: char) -> Self

Creates a text-producing key press with unknown physical origin.

pub const fn modified_text(c: char, mods: KeyMods) -> Self

Creates a modified text-producing key press with unknown physical origin.

pub const fn with_state(self, state: KeyState) -> Self

Returns this key event with a different state.

pub const fn with_mods(self, mods: KeyMods) -> Self

Returns this key event with different modifiers.

Trait Implementations

impl Clone for EventKey

fn clone(&self) -> EventKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for EventKey

const INIT: Self

Returns the compile-time “initial value” for a type.

impl Copy for EventKey

impl Debug for EventKey

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

Formats the value using the given formatter.

impl Default for EventKey

fn default() -> EventKey

Returns the “default value” for a type.

impl Eq for EventKey

impl From<&EventKey> for EventKeyFfi

Available on ffi·· only.

fn from(e: &EventKey) -> Self

Converts to this type from the input type.

impl From<&EventKeyFfi> for EventKey

Available on ffi·· only.

fn from(e: &EventKeyFfi) -> Self

Converts to this type from the input type.

impl From<EventKey> for EventKeyFfi

Available on ffi·· only.

fn from(e: EventKey) -> Self

Converts to this type from the input type.

impl From<EventKeyFfi> for EventKey

Available on ffi·· only.

fn from(e: EventKeyFfi) -> Self

Converts to this type from the input type.

impl Hash for EventKey

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 EventKey

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