Struct KeyPress 

#[non_exhaustive]
pub struct KeyPress {
    pub logical: LogicalKey,
    pub physical: PhysicalKey,
    pub modifiers: KeyModifiers,
    pub repeat: bool,
}

One keyboard key-down, as delivered on UiEvent::key_press. Hosts feed the constituent parts through [crate::runtime::RunnerCore::key_down]; the runtime packages them into this struct on the events it emits.

Two of the three W3C key facets live here: logical (the key’s meaning) and physical (its layout-independent position). The third — committed text — is a separate UiEventKind::TextInput event (UiEvent::text), so this struct never carries produced text.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

logical: LogicalKey

The logical key — meaning under the active layout + modifiers. Use for activation, navigation, and legend-following accelerators.

physical: PhysicalKey

The physical key — layout-independent board position. Use for rebindable controls, games, global hotkeys, and disambiguating duplicate keys (numpad vs main row). PhysicalKey::Unidentified when the host can’t report a position.

modifiers: KeyModifiers

Modifier mask at the moment of the press.

repeat: bool

True when this press is an OS auto-repeat of a held key rather than a fresh key-down.

Implementations

impl KeyPress

pub fn new( logical: LogicalKey, physical: PhysicalKey, modifiers: KeyModifiers, repeat: bool, ) -> Self

Construct a key press from its facets. Hosts call this to feed [crate::runtime::RunnerCore::key_down]. KeyPress is #[non_exhaustive], so this constructor is the supported way to build one outside the core crate.

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

impl PartialEq for KeyPress

fn eq(&self, other: &KeyPress) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyPress