Skip to main content

KeyboardEvent

Struct KeyboardEvent 

Source
pub struct KeyboardEvent {
    pub input: Option<KeyInput>,
    pub physical_key: PhysicalKey,
    pub state: KeyState,
    pub modifiers: ModifierState,
}
Expand description

This type represents a key event (press or release).

Each event carries a physical_key identifying which key on the keyboard was pressed or released.

On presses, input contains the resolved KeyInput after applying shift/Fn modifiers. On releases it is None.

If you only care about basic input then you can just use input. If you need raw information about pressed and released keys (games, custom bindings) you can use physical_key and the additional information in this struct.

Fields§

§input: Option<KeyInput>

The resolved semantic input, if applicable.

Some on key press, None on key release. Release events should be matched by physical_key, not by resolved input, since the modifier state may have changed between press and release.

§physical_key: PhysicalKey

Which physical key was pressed or released. This is always independent of modifier keys.

§state: KeyState

Whether the key was pressed or released.

§modifiers: ModifierState

The modifier state at the time of this event.

Trait Implementations§

Source§

impl Clone for KeyboardEvent

Source§

fn clone(&self) -> KeyboardEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyboardEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for KeyboardEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for KeyboardEvent

Source§

impl Eq for KeyboardEvent

Source§

impl StructuralPartialEq for KeyboardEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.