Struct web_sys::CustomEvent
source · pub struct CustomEvent { /* private fields */ }
Expand description
The CustomEvent
class.
This API requires the following crate features to be activated: CustomEvent
Implementations§
source§impl CustomEvent
impl CustomEvent
source§impl CustomEvent
impl CustomEvent
source§impl CustomEvent
impl CustomEvent
sourcepub fn new_with_event_init_dict(
type_: &str,
event_init_dict: &CustomEventInit,
) -> Result<CustomEvent, JsValue>
pub fn new_with_event_init_dict( type_: &str, event_init_dict: &CustomEventInit, ) -> Result<CustomEvent, JsValue>
The new CustomEvent(..)
constructor, creating a new instance of CustomEvent
.
This API requires the following crate features to be activated: CustomEvent
, CustomEventInit
source§impl CustomEvent
impl CustomEvent
sourcepub fn init_custom_event(&self, type_: &str)
pub fn init_custom_event(&self, type_: &str)
The initCustomEvent()
method.
This API requires the following crate features to be activated: CustomEvent
source§impl CustomEvent
impl CustomEvent
sourcepub fn init_custom_event_with_can_bubble(&self, type_: &str, can_bubble: bool)
pub fn init_custom_event_with_can_bubble(&self, type_: &str, can_bubble: bool)
The initCustomEvent()
method.
This API requires the following crate features to be activated: CustomEvent
source§impl CustomEvent
impl CustomEvent
sourcepub fn init_custom_event_with_can_bubble_and_cancelable(
&self,
type_: &str,
can_bubble: bool,
cancelable: bool,
)
pub fn init_custom_event_with_can_bubble_and_cancelable( &self, type_: &str, can_bubble: bool, cancelable: bool, )
The initCustomEvent()
method.
This API requires the following crate features to be activated: CustomEvent
source§impl CustomEvent
impl CustomEvent
Methods from Deref<Target = Event>§
sourcepub fn type_(&self) -> String
pub fn type_(&self) -> String
Getter for the type
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn target(&self) -> Option<EventTarget>
pub fn target(&self) -> Option<EventTarget>
Getter for the target
field of this object.
This API requires the following crate features to be activated: Event
, EventTarget
sourcepub fn current_target(&self) -> Option<EventTarget>
pub fn current_target(&self) -> Option<EventTarget>
Getter for the currentTarget
field of this object.
This API requires the following crate features to be activated: Event
, EventTarget
sourcepub fn event_phase(&self) -> u16
pub fn event_phase(&self) -> u16
Getter for the eventPhase
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn bubbles(&self) -> bool
pub fn bubbles(&self) -> bool
Getter for the bubbles
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn cancelable(&self) -> bool
pub fn cancelable(&self) -> bool
Getter for the cancelable
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn default_prevented(&self) -> bool
pub fn default_prevented(&self) -> bool
Getter for the defaultPrevented
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn composed(&self) -> bool
pub fn composed(&self) -> bool
Getter for the composed
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn is_trusted(&self) -> bool
pub fn is_trusted(&self) -> bool
Getter for the isTrusted
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn time_stamp(&self) -> f64
pub fn time_stamp(&self) -> f64
Getter for the timeStamp
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn cancel_bubble(&self) -> bool
pub fn cancel_bubble(&self) -> bool
Getter for the cancelBubble
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn set_cancel_bubble(&self, value: bool)
pub fn set_cancel_bubble(&self, value: bool)
Setter for the cancelBubble
field of this object.
This API requires the following crate features to be activated: Event
sourcepub fn composed_path(&self) -> Array
pub fn composed_path(&self) -> Array
The composedPath()
method.
This API requires the following crate features to be activated: Event
sourcepub fn init_event(&self, type_: &str)
pub fn init_event(&self, type_: &str)
The initEvent()
method.
This API requires the following crate features to be activated: Event
sourcepub fn init_event_with_bubbles(&self, type_: &str, bubbles: bool)
pub fn init_event_with_bubbles(&self, type_: &str, bubbles: bool)
The initEvent()
method.
This API requires the following crate features to be activated: Event
sourcepub fn init_event_with_bubbles_and_cancelable(
&self,
type_: &str,
bubbles: bool,
cancelable: bool,
)
pub fn init_event_with_bubbles_and_cancelable( &self, type_: &str, bubbles: bool, cancelable: bool, )
The initEvent()
method.
This API requires the following crate features to be activated: Event
sourcepub fn prevent_default(&self)
pub fn prevent_default(&self)
The preventDefault()
method.
This API requires the following crate features to be activated: Event
sourcepub fn stop_immediate_propagation(&self)
pub fn stop_immediate_propagation(&self)
The stopImmediatePropagation()
method.
This API requires the following crate features to be activated: Event
sourcepub fn stop_propagation(&self)
pub fn stop_propagation(&self)
The stopPropagation()
method.
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>§
sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object
constructor
function that created the instance object.
sourcepub fn has_own_property(&self, property: &JsValue) -> bool
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).
sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
sourcepub fn to_locale_string(&self) -> JsString
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.
sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString()
method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
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
.
sourcepub fn as_string(&self) -> Option<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.
sourcepub fn as_bool(&self) -> Option<bool>
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
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<CustomEvent> for CustomEvent
impl AsRef<CustomEvent> for CustomEvent
source§fn as_ref(&self) -> &CustomEvent
fn as_ref(&self) -> &CustomEvent
source§impl AsRef<Event> for CustomEvent
impl AsRef<Event> for CustomEvent
source§impl AsRef<JsValue> for CustomEvent
impl AsRef<JsValue> for CustomEvent
source§impl AsRef<Object> for CustomEvent
impl AsRef<Object> for CustomEvent
source§impl Clone for CustomEvent
impl Clone for CustomEvent
source§fn clone(&self) -> CustomEvent
fn clone(&self) -> CustomEvent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CustomEvent
impl Debug for CustomEvent
source§impl Deref for CustomEvent
impl Deref for CustomEvent
source§impl From<CustomEvent> for Event
impl From<CustomEvent> for Event
source§fn from(obj: CustomEvent) -> Event
fn from(obj: CustomEvent) -> Event
source§impl From<CustomEvent> for JsValue
impl From<CustomEvent> for JsValue
source§fn from(obj: CustomEvent) -> JsValue
fn from(obj: CustomEvent) -> JsValue
source§impl From<CustomEvent> for Object
impl From<CustomEvent> for Object
source§fn from(obj: CustomEvent) -> Object
fn from(obj: CustomEvent) -> Object
source§impl From<JsValue> for CustomEvent
impl From<JsValue> for CustomEvent
source§fn from(obj: JsValue) -> CustomEvent
fn from(obj: JsValue) -> CustomEvent
source§impl FromWasmAbi for CustomEvent
impl FromWasmAbi for CustomEvent
source§impl<'a> IntoWasmAbi for &'a CustomEvent
impl<'a> IntoWasmAbi for &'a CustomEvent
source§impl IntoWasmAbi for CustomEvent
impl IntoWasmAbi for CustomEvent
source§impl JsCast for CustomEvent
impl JsCast for CustomEvent
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for CustomEvent
impl LongRefFromWasmAbi for CustomEvent
source§type Anchor = CustomEvent
type Anchor = CustomEvent
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for CustomEvent
impl OptionFromWasmAbi for CustomEvent
source§impl<'a> OptionIntoWasmAbi for &'a CustomEvent
impl<'a> OptionIntoWasmAbi for &'a CustomEvent
source§impl OptionIntoWasmAbi for CustomEvent
impl OptionIntoWasmAbi for CustomEvent
source§impl PartialEq for CustomEvent
impl PartialEq for CustomEvent
source§impl RefFromWasmAbi for CustomEvent
impl RefFromWasmAbi for CustomEvent
source§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.source§type Anchor = ManuallyDrop<CustomEvent>
type Anchor = ManuallyDrop<CustomEvent>
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.impl Eq for CustomEvent
impl StructuralPartialEq for CustomEvent
Auto Trait Implementations§
impl Freeze for CustomEvent
impl RefUnwindSafe for CustomEvent
impl !Send for CustomEvent
impl !Sync for CustomEvent
impl Unpin for CustomEvent
impl UnwindSafe for CustomEvent
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.