Struct WebEventKey 

#[repr(C)]
pub struct WebEventKey {
    pub key: js_uint32,
    pub state: KeyState,
    pub location: WebKeyLocation,
    pub mods: KeyMods,
    pub timestamp: JsInstant,
}

Available on crate features event and web only.

🎫 🌐 A web API keyboard event.

---

^{📍 sys/os/browser/web}

^{📦 size_of::<WebEventKey>() == 16 bytes / 128 bits ⚗️Option<T>}

---

Represents a JavaScript KeyboardEvent in a compact callback-friendly form.

key is the Unicode scalar value of KeyboardEvent.key when it contains exactly one Unicode scalar, or 0 for non-text keys such as Enter.

Fields

key: js_uint32

Unicode scalar from KeyboardEvent.key, or 0 for non-text keys.

state: KeyState

The key transition state.

location: WebKeyLocation

Which part of the keyboard produced the event.

mods: KeyMods

Active keyboard modifiers.

timestamp: JsInstant

The JavaScript event timestamp.

Implementations

impl WebEventKey

pub const fn new( key: js_uint32, state: KeyState, location: WebKeyLocation, mods: KeyMods, timestamp: JsInstant, ) -> Self

Returns a new keyboard event.

pub const fn has_key_scalar(self) -> bool

Returns whether this event carries a text scalar.

pub const fn to_event_key(self) -> EventKey

Converts WebEventKey to a normalized EventKey.

Returns None if the web event kind is not a keyboard event.

pub const fn to_kind_timed(self) -> EventKindTimed

Converts WebEventKey to EventKindTimed.

Returns None if the web event kind is not a keyboard event.

pub const fn from_event_key(from: EventKey) -> WebEventKey

Converts a normalized EventKey back to WebEventKey.

This is necessarily partial because WebEventKey stores only a scalar key, not the browser KeyboardEvent.key and KeyboardEvent.code strings.

pub const fn from_event_key_timed( from: Timed<EventKey, Option<EventTimestamp>>, ) -> WebEventKey

Converts a timed normalized EventKey back to WebEventKey.

Trait Implementations

impl Clone for WebEventKey

fn clone(&self) -> WebEventKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WebEventKey

impl Debug for WebEventKey

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

Formats the value using the given formatter.

impl From<Timed<EventKey, Option<EventTimestamp>>> for WebEventKey

fn from(from: Timed<EventKey, Option<EventTimestamp>>) -> Self

Converts to this type from the input type.

impl From<WebEventKey> for EventKindTimed

fn from(from: WebEventKey) -> Self

Converts to this type from the input type.

impl PartialEq for WebEventKey

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