Struct web_sys::KeyboardEvent

pub struct KeyboardEvent { /* private fields */ }

The KeyboardEvent class.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

Implementations

impl KeyboardEvent

pub fn char_code(&self) -> u32

Getter for the charCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn key_code(&self) -> u32

Getter for the keyCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn alt_key(&self) -> bool

Getter for the altKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn ctrl_key(&self) -> bool

Getter for the ctrlKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn shift_key(&self) -> bool

Getter for the shiftKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn meta_key(&self) -> bool

Getter for the metaKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn location(&self) -> u32

Getter for the location field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn repeat(&self) -> bool

Getter for the repeat field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn is_composing(&self) -> bool

Getter for the isComposing field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn key(&self) -> String

Getter for the key field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn code(&self) -> String

Getter for the code field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn new(type_arg: &str) -> Result<KeyboardEvent, JsValue>

The new KeyboardEvent(..) constructor, creating a new instance of KeyboardEvent.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn new_with_keyboard_event_init_dict( type_arg: &str, keyboard_event_init_dict: &KeyboardEventInit, ) -> Result<KeyboardEvent, JsValue>

The new KeyboardEvent(..) constructor, creating a new instance of KeyboardEvent.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, KeyboardEventInit

impl KeyboardEvent

pub fn get_modifier_state(&self, key: &str) -> bool

The getModifierState() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event(&self, type_arg: &str) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg( &self, type_arg: &str, bubbles_arg: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, shift_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key_and_meta_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, shift_key: bool, meta_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub const DOM_KEY_LOCATION_STANDARD: u32 = 0u32

The KeyboardEvent.DOM_KEY_LOCATION_STANDARD const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_LEFT: u32 = 1u32

The KeyboardEvent.DOM_KEY_LOCATION_LEFT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_RIGHT: u32 = 2u32

The KeyboardEvent.DOM_KEY_LOCATION_RIGHT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_NUMPAD: u32 = 3u32

The KeyboardEvent.DOM_KEY_LOCATION_NUMPAD const.

This API requires the following crate features to be activated: KeyboardEvent

Methods from Deref<Target = UiEvent>

pub fn view(&self) -> Option<Window>

Getter for the view field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn detail(&self) -> i32

Getter for the detail field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_x(&self) -> i32

Getter for the layerX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_y(&self) -> i32

Getter for the layerY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_x(&self) -> i32

Getter for the pageX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_y(&self) -> i32

Getter for the pageY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn which(&self) -> u32

Getter for the which field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn range_parent(&self) -> Option<Node>

Getter for the rangeParent field of this object.

MDN Documentation

This API requires the following crate features to be activated: Node, UiEvent

pub fn range_offset(&self) -> i32

Getter for the rangeOffset field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event(&self, a_type: &str)

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble(&self, a_type: &str, a_can_bubble: bool)

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, a_view: Option<&Window>, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view_and_a_detail( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, a_view: Option<&Window>, a_detail: i32, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub const SCROLL_PAGE_UP: i32 = -32_768i32

pub const SCROLL_PAGE_DOWN: i32 = 32_768i32

Methods from Deref<Target = Event>

pub fn type_(&self) -> String

Getter for the type field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn target(&self) -> Option<EventTarget>

Getter for the target field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn current_target(&self) -> Option<EventTarget>

Getter for the currentTarget field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn event_phase(&self) -> u16

Getter for the eventPhase field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn bubbles(&self) -> bool

Getter for the bubbles field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancelable(&self) -> bool

Getter for the cancelable field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn default_prevented(&self) -> bool

Getter for the defaultPrevented field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed(&self) -> bool

Getter for the composed field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn is_trusted(&self) -> bool

Getter for the isTrusted field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn time_stamp(&self) -> f64

Getter for the timeStamp field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancel_bubble(&self) -> bool

Getter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn set_cancel_bubble(&self, value: bool)

Setter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed_path(&self) -> Array

The composedPath() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event(&self, type_: &str)

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles(&self, type_: &str, bubbles: bool)

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles_and_cancelable( &self, type_: &str, bubbles: bool, cancelable: bool, )

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn prevent_default(&self)

The preventDefault() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_immediate_propagation(&self)

The stopImmediatePropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_propagation(&self)

The stopPropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub const NONE: u16 = 0u16

pub const CAPTURING_PHASE: u16 = 1u16

pub const AT_TARGET: u16 = 2u16

pub const BUBBLING_PHASE: u16 = 3u16

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

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

Applies the binary < JS operator on the two JsValues.

MDN documentation

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

Applies the binary <= JS operator on the two JsValues.

MDN documentation

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

Applies the binary >= JS operator on the two JsValues.

MDN documentation

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

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<Event> for KeyboardEvent

fn as_ref(&self) -> &Event

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for KeyboardEvent

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<KeyboardEvent> for KeyboardEvent

fn as_ref(&self) -> &KeyboardEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for KeyboardEvent

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UiEvent> for KeyboardEvent

fn as_ref(&self) -> &UiEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a copy 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 Deref for KeyboardEvent

type Target = UiEvent

The resulting type after dereferencing.

fn deref(&self) -> &UiEvent

Dereferences the value.

impl From<JsValue> for KeyboardEvent

fn from(obj: JsValue) -> KeyboardEvent

Converts to this type from the input type.

impl From<KeyboardEvent> for Event

fn from(obj: KeyboardEvent) -> Event

Converts to this type from the input type.

impl From<KeyboardEvent> for JsValue

fn from(obj: KeyboardEvent) -> JsValue

Converts to this type from the input type.

impl From<KeyboardEvent> for Object

fn from(obj: KeyboardEvent) -> Object

Converts to this type from the input type.

impl From<KeyboardEvent> for UiEvent

fn from(obj: KeyboardEvent) -> UiEvent

Converts to this type from the input type.

impl FromWasmAbi for KeyboardEvent

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a KeyboardEvent

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for KeyboardEvent

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for KeyboardEvent

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for KeyboardEvent

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = KeyboardEvent

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for KeyboardEvent

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a KeyboardEvent

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for KeyboardEvent

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

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

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<KeyboardEvent>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for KeyboardEvent

fn describe()

impl Eq for KeyboardEvent

impl StructuralPartialEq for KeyboardEvent