Struct KeyboardEvent 

pub struct KeyboardEvent {
    pub state: KeyState,
    pub key: Key,
    pub code: Code,
    pub location: Location,
    pub modifiers: Modifiers,
    pub repeat: bool,
    pub is_composing: bool,
}

Standardized keyboard values shared by every platform adapter.

Code identifies the physical key position; Key is the logical key value after the operating system’s layout processing. Incular does not maintain a parallel keyboard vocabulary. Keyboard events are issued for all pressed and released keys.

Fields

state: KeyState

Whether the key is pressed or released.

key: Key

Logical key value.

code: Code

Physical key position.

location: Location

Location for keys with multiple instances on common keyboards.

modifiers: Modifiers

Flags for pressed modifier keys.

repeat: bool

True if the key is currently auto-repeated.

is_composing: bool

Events with this flag should be ignored in a text editor and instead composition events should be used.

Implementations

impl KeyboardEvent

pub fn key_down(key: impl Into<Key>, code: Code) -> KeyboardEvent

Convenience constructor which takes key and code, sets state to KeyState::Down, and sets everything else to default values.

pub fn key_up(key: impl Into<Key>, code: Code) -> KeyboardEvent

Convenience constructor which takes key and code, sets state to KeyState::Up, and sets everything else to default values.

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<(), Error>

Formats the value using the given formatter.

impl Default for KeyboardEvent

fn default() -> KeyboardEvent

Returns the “default value” for a type.

impl Eq for KeyboardEvent

impl Hash for KeyboardEvent

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for KeyboardEvent

fn cmp(&self, other: &KeyboardEvent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for KeyboardEvent

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for KeyboardEvent

fn partial_cmp(&self, other: &KeyboardEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for KeyboardEvent