Struct sauron::prelude::web_sys::Event

#[repr(transparent)]pub struct Event { /* fields omitted */ }

The Event class.

MDN Documentation

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

Implementations

impl Event

pub const NONE: u16

The Event.NONE const.

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

pub const CAPTURING_PHASE: u16

The Event.CAPTURING_PHASE const.

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

pub const AT_TARGET: u16

The Event.AT_TARGET const.

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

pub const BUBBLING_PHASE: u16

The Event.BUBBLING_PHASE const.

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

impl 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

impl 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

impl Event

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

impl Event

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

impl 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

impl 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

impl 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

impl 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

impl 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

impl 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

impl 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

impl 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

impl Event

pub fn new(type_: &str) -> Result<Event, JsValue>

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

MDN Documentation

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

impl Event

pub fn composed_path(&self) -> Array

The composedPath() method.

MDN Documentation

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

impl Event

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

The initEvent() method.

MDN Documentation

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

impl 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

impl 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

impl Event

pub fn prevent_default(&self)

The preventDefault() method.

MDN Documentation

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

impl Event

pub fn stop_immediate_propagation(&self)

The stopImmediatePropagation() method.

MDN Documentation

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

impl Event

pub fn stop_propagation(&self)

The stopPropagation() method.

MDN Documentation

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

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 into_serde<T>(&self) -> Result<T, Error> where
    T: for<'a> Deserialize<'a>, 

Invokes JSON.stringify on this value and then parses the resulting JSON into an arbitrary Rust value.

This function will first call JSON.stringify on the JsValue itself. The resulting string is then passed into Rust which then parses it as JSON into the resulting value.

Usage of this API requires activating the serde-serialize feature of the wasm-bindgen crate.

Errors

Returns any error encountered when parsing the JSON into a T.

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_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Event> for AnimationEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for KeyboardEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for MessageEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for HashChangeEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for InputEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for TransitionEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for UiEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for MouseEvent

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for Event

pub fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<JsValue> for Event

pub fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for Event

pub fn as_ref(&self) -> &Object

Performs the conversion.

impl Clone for Event

pub fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Deref for Event

type Target = Object

The resulting type after dereferencing.

pub fn deref(&self) -> &Object

Dereferences the value.

impl Eq for Event

impl From<AnimationEvent> for Event

pub fn from(obj: AnimationEvent) -> Event

Performs the conversion.

impl From<Event> for Event

pub fn from(web_event: Event) -> Event

Performs the conversion.

impl From<Event> for Object

pub fn from(obj: Event) -> Object

Performs the conversion.

impl From<Event> for JsValue

pub fn from(obj: Event) -> JsValue

Performs the conversion.

impl From<HashChangeEvent> for Event

pub fn from(obj: HashChangeEvent) -> Event

Performs the conversion.

impl From<InputEvent> for Event

pub fn from(obj: InputEvent) -> Event

Performs the conversion.

impl From<JsValue> for Event

pub fn from(obj: JsValue) -> Event

Performs the conversion.

impl From<KeyboardEvent> for Event

pub fn from(obj: KeyboardEvent) -> Event

Performs the conversion.

impl From<MessageEvent> for Event

pub fn from(obj: MessageEvent) -> Event

Performs the conversion.

impl From<MouseEvent> for Event

pub fn from(obj: MouseEvent) -> Event

Performs the conversion.

impl From<TransitionEvent> for Event

pub fn from(obj: TransitionEvent) -> Event

Performs the conversion.

impl From<UiEvent> for Event

pub fn from(obj: UiEvent) -> Event

Performs the conversion.

impl FromWasmAbi for Event

type Abi = <JsValue as FromWasmAbi>::Abi

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

pub unsafe fn from_abi(js: <Event as FromWasmAbi>::Abi) -> Event

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Event

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

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

pub fn into_abi(self) -> <&'a Event as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for Event

type Abi = <JsValue as IntoWasmAbi>::Abi

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

pub fn into_abi(self) -> <Event as IntoWasmAbi>::Abi

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

impl JsCast for Event

pub fn instanceof(val: &JsValue) -> bool

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

pub fn unchecked_from_js(val: JsValue) -> Event

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

pub fn unchecked_from_js_ref(val: &JsValue) -> &Event

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

pub fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

pub 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.

pub 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.

pub fn unchecked_into<T>(self) -> T where
    T: JsCast, 

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

pub fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

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

pub fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

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

pub fn is_type_of(val: &JsValue) -> bool

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

impl OptionFromWasmAbi for Event

pub fn is_none(abi: &<Event as FromWasmAbi>::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 OptionIntoWasmAbi for Event

pub fn none() -> <Event as IntoWasmAbi>::Abi

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

impl<'a> OptionIntoWasmAbi for &'a Event

pub fn none() -> <&'a Event as IntoWasmAbi>::Abi

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

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl RefFromWasmAbi for Event

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Event>

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.

pub unsafe fn ref_from_abi(
    js: <Event as RefFromWasmAbi>::Abi
) -> <Event as RefFromWasmAbi>::Anchor

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

impl StructuralEq for Event

impl StructuralPartialEq for Event