Struct web_sys::KeyboardEventInit

pub struct KeyboardEventInit { /* private fields */ }

The KeyboardEventInit dictionary.

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

Implementations

impl KeyboardEventInit

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

Get the bubbles field of this object.

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

impl KeyboardEventInit

pub fn set_bubbles(&self, val: bool)

Change the bubbles field of this object.

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

impl KeyboardEventInit

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

Get the cancelable field of this object.

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

impl KeyboardEventInit

pub fn set_cancelable(&self, val: bool)

Change the cancelable field of this object.

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

impl KeyboardEventInit

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

Get the composed field of this object.

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

impl KeyboardEventInit

pub fn set_composed(&self, val: bool)

Change the composed field of this object.

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

impl KeyboardEventInit

pub fn get_detail(&self) -> Option<i32>

Get the detail field of this object.

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

impl KeyboardEventInit

pub fn set_detail(&self, val: i32)

Change the detail field of this object.

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

impl KeyboardEventInit

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

Get the view field of this object.

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

impl KeyboardEventInit

pub fn set_view(&self, val: Option<&Window>)

Change the view field of this object.

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

impl KeyboardEventInit

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

Get the altKey field of this object.

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

impl KeyboardEventInit

pub fn set_alt_key(&self, val: bool)

Change the altKey field of this object.

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

impl KeyboardEventInit

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

Get the ctrlKey field of this object.

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

impl KeyboardEventInit

pub fn set_ctrl_key(&self, val: bool)

Change the ctrlKey field of this object.

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

impl KeyboardEventInit

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

Get the metaKey field of this object.

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

impl KeyboardEventInit

pub fn set_meta_key(&self, val: bool)

Change the metaKey field of this object.

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

impl KeyboardEventInit

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

Get the modifierAltGraph field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_alt_graph(&self, val: bool)

Change the modifierAltGraph field of this object.

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

impl KeyboardEventInit

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

Get the modifierCapsLock field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_caps_lock(&self, val: bool)

Change the modifierCapsLock field of this object.

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

impl KeyboardEventInit

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

Get the modifierFn field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_fn(&self, val: bool)

Change the modifierFn field of this object.

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

impl KeyboardEventInit

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

Get the modifierFnLock field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_fn_lock(&self, val: bool)

Change the modifierFnLock field of this object.

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

impl KeyboardEventInit

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

Get the modifierNumLock field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_num_lock(&self, val: bool)

Change the modifierNumLock field of this object.

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

impl KeyboardEventInit

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

Get the modifierOS field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_os(&self, val: bool)

Change the modifierOS field of this object.

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

impl KeyboardEventInit

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

Get the modifierScrollLock field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_scroll_lock(&self, val: bool)

Change the modifierScrollLock field of this object.

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

impl KeyboardEventInit

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

Get the modifierSymbol field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_symbol(&self, val: bool)

Change the modifierSymbol field of this object.

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

impl KeyboardEventInit

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

Get the modifierSymbolLock field of this object.

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

impl KeyboardEventInit

pub fn set_modifier_symbol_lock(&self, val: bool)

Change the modifierSymbolLock field of this object.

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

impl KeyboardEventInit

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

Get the shiftKey field of this object.

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

impl KeyboardEventInit

pub fn set_shift_key(&self, val: bool)

Change the shiftKey field of this object.

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

impl KeyboardEventInit

pub fn get_char_code(&self) -> Option<u32>

Get the charCode field of this object.

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

impl KeyboardEventInit

pub fn set_char_code(&self, val: u32)

Change the charCode field of this object.

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

impl KeyboardEventInit

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

Get the code field of this object.

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

impl KeyboardEventInit

pub fn set_code(&self, val: &str)

Change the code field of this object.

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

impl KeyboardEventInit

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

Get the isComposing field of this object.

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

impl KeyboardEventInit

pub fn set_is_composing(&self, val: bool)

Change the isComposing field of this object.

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

impl KeyboardEventInit

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

Get the key field of this object.

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

impl KeyboardEventInit

pub fn set_key(&self, val: &str)

Change the key field of this object.

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

impl KeyboardEventInit

pub fn get_key_code(&self) -> Option<u32>

Get the keyCode field of this object.

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

impl KeyboardEventInit

pub fn set_key_code(&self, val: u32)

Change the keyCode field of this object.

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

impl KeyboardEventInit

pub fn get_location(&self) -> Option<u32>

Get the location field of this object.

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

impl KeyboardEventInit

pub fn set_location(&self, val: u32)

Change the location field of this object.

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

impl KeyboardEventInit

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

Get the repeat field of this object.

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

impl KeyboardEventInit

pub fn set_repeat(&self, val: bool)

Change the repeat field of this object.

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

impl KeyboardEventInit

pub fn get_which(&self) -> Option<u32>

Get the which field of this object.

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

impl KeyboardEventInit

pub fn set_which(&self, val: u32)

Change the which field of this object.

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

impl KeyboardEventInit

pub fn new() -> Self

Construct a new KeyboardEventInit.

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

pub fn bubbles(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_bubbles() instead.

pub fn cancelable(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_cancelable() instead.

pub fn composed(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_composed() instead.

pub fn detail(&mut self, val: i32) -> &mut Self

👎Deprecated: Use set_detail() instead.

pub fn view(&mut self, val: Option<&Window>) -> &mut Self

👎Deprecated: Use set_view() instead.

pub fn alt_key(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_alt_key() instead.

pub fn ctrl_key(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_ctrl_key() instead.

pub fn meta_key(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_meta_key() instead.

pub fn modifier_alt_graph(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_alt_graph() instead.

pub fn modifier_caps_lock(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_caps_lock() instead.

pub fn modifier_fn(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_fn() instead.

pub fn modifier_fn_lock(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_fn_lock() instead.

pub fn modifier_num_lock(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_num_lock() instead.

pub fn modifier_os(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_os() instead.

pub fn modifier_scroll_lock(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_scroll_lock() instead.

pub fn modifier_symbol(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_symbol() instead.

pub fn modifier_symbol_lock(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_modifier_symbol_lock() instead.

pub fn shift_key(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_shift_key() instead.

pub fn char_code(&mut self, val: u32) -> &mut Self

👎Deprecated: Use set_char_code() instead.

pub fn code(&mut self, val: &str) -> &mut Self

👎Deprecated: Use set_code() instead.

pub fn is_composing(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_is_composing() instead.

pub fn key(&mut self, val: &str) -> &mut Self

👎Deprecated: Use set_key() instead.

pub fn key_code(&mut self, val: u32) -> &mut Self

👎Deprecated: Use set_key_code() instead.

pub fn location(&mut self, val: u32) -> &mut Self

👎Deprecated: Use set_location() instead.

pub fn repeat(&mut self, val: bool) -> &mut Self

👎Deprecated: Use set_repeat() instead.

pub fn which(&mut self, val: u32) -> &mut Self

👎Deprecated: Use set_which() instead.

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<JsValue> for KeyboardEventInit

fn as_ref(&self) -> &JsValue

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

impl AsRef<KeyboardEventInit> for KeyboardEventInit

fn as_ref(&self) -> &KeyboardEventInit

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

impl AsRef<Object> for KeyboardEventInit

fn as_ref(&self) -> &Object

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

impl Clone for KeyboardEventInit

fn clone(&self) -> KeyboardEventInit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardEventInit

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

Formats the value using the given formatter.

impl Default for KeyboardEventInit

fn default() -> Self

Returns the “default value” for a type.

impl Deref for KeyboardEventInit

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<JsValue> for KeyboardEventInit

fn from(obj: JsValue) -> KeyboardEventInit

Converts to this type from the input type.

impl From<KeyboardEventInit> for JsValue

fn from(obj: KeyboardEventInit) -> JsValue

Converts to this type from the input type.

impl From<KeyboardEventInit> for Object

fn from(obj: KeyboardEventInit) -> Object

Converts to this type from the input type.

impl FromWasmAbi for KeyboardEventInit

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 KeyboardEventInit

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 KeyboardEventInit

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 KeyboardEventInit

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 KeyboardEventInit

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = KeyboardEventInit

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for KeyboardEventInit

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 KeyboardEventInit

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for KeyboardEventInit

fn none() -> Self::Abi

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

impl PartialEq for KeyboardEventInit

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

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<KeyboardEventInit>

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 KeyboardEventInit

fn describe()

impl Eq for KeyboardEventInit

impl StructuralPartialEq for KeyboardEventInit