Enum KeyboardEvent 

pub enum KeyboardEvent {
    Down {
        key: Key,
        physical: Option<PhysicalKey>,
        modifiers: Modifiers,
        repeat: bool,
    },
    Up {
        key: Key,
        physical: Option<PhysicalKey>,
        modifiers: Modifiers,
    },
    CharInput {
        text: String,
    },
}

A keyboard event carrying both logical and physical key information.

Variants

Down

A key was pressed (or auto-repeated; see repeat).

Fields

key: Key

The logical key (layout/IME mapped).

physical: Option<PhysicalKey>

The physical key location, if known.

modifiers: Modifiers

Modifier state.

repeat: bool

true if this is an OS auto-repeat of a held key.

Up

A key was released.

Fields

key: Key

The logical key.

physical: Option<PhysicalKey>

The physical key location, if known.

modifiers: Modifiers

Modifier state.

CharInput

Committed text input (post-IME). Distinct from Down so a text field can ignore navigation keys while still receiving typed characters.

Fields

text: String

The committed text (may be multiple code points).

Implementations

impl KeyboardEvent

pub fn is_repeat(&self) -> bool

Returns true if this is an auto-repeat Down event.

Trait Implementations

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardEvent

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

Formats the value using the given formatter.

impl PartialEq for KeyboardEvent

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