Struct web_sys::CustomEvent

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

The CustomEvent object

MDN Documentation

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

Methods

impl CustomEvent

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

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

MDN Documentation

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

impl CustomEvent

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

MDN Documentation

This API requires the following crate features to be activated: CustomEvent, CustomEventInit

impl CustomEvent

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

The initCustomEvent() method

MDN Documentation

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

impl CustomEvent

pub fn init_custom_event_with_can_bubble(&self, type_: &str, can_bubble: bool)

The initCustomEvent() method

MDN Documentation

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

impl CustomEvent

pub fn init_custom_event_with_can_bubble_and_cancelable(
    &self,
    type_: &str,
    can_bubble: bool,
    cancelable: bool
)

The initCustomEvent() method

MDN Documentation

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

impl CustomEvent

pub fn init_custom_event_with_can_bubble_and_cancelable_and_detail(
    &self,
    type_: &str,
    can_bubble: bool,
    cancelable: bool,
    detail: &JsValue
)

The initCustomEvent() method

MDN Documentation

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

impl CustomEvent

pub fn detail(&self) -> JsValue

The detail getter

MDN Documentation

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

Methods from Deref<Target = 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 fn type_(&self) -> String

The type getter

MDN Documentation

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

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

The target getter

MDN Documentation

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

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

The currentTarget getter

MDN Documentation

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

pub fn event_phase(&self) -> u16

The eventPhase getter

MDN Documentation

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

pub fn bubbles(&self) -> bool

The bubbles getter

MDN Documentation

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

pub fn cancelable(&self) -> bool

The cancelable getter

MDN Documentation

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

pub fn default_prevented(&self) -> bool

The defaultPrevented getter

MDN Documentation

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

pub fn composed(&self) -> bool

The composed getter

MDN Documentation

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

pub fn is_trusted(&self) -> bool

The isTrusted getter

MDN Documentation

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

pub fn time_stamp(&self) -> f64

The timeStamp getter

MDN Documentation

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

pub fn cancel_bubble(&self) -> bool

The cancelBubble getter

MDN Documentation

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

pub fn set_cancel_bubble(&self, cancel_bubble: bool)

The cancelBubble setter

MDN Documentation

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

pub const NONE: u16

pub const CAPTURING_PHASE: u16

pub const AT_TARGET: u16

pub const BUBBLING_PHASE: u16

Trait Implementations

impl AsRef<JsValue> for CustomEvent

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Event> for CustomEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Object> for CustomEvent

fn as_ref(&self) -> &Object

Performs the conversion.

impl From<JsValue> for CustomEvent

fn from(obj: JsValue) -> CustomEvent

Performs the conversion.

impl From<CustomEvent> for JsValue

fn from(obj: CustomEvent) -> JsValue

Performs the conversion.

impl From<CustomEvent> for Event

fn from(obj: CustomEvent) -> Event

Performs the conversion.

impl From<CustomEvent> for Object

fn from(obj: CustomEvent) -> Object

Performs the conversion.

impl Clone for CustomEvent

fn clone(&self) -> CustomEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomEvent

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

Formats the value using the given formatter.

impl Deref for CustomEvent

type Target = Event

The resulting type after dereferencing.

fn deref(&self) -> &Event

Dereferences the value.

impl JsCast for CustomEvent

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 is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the 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.

impl FromWasmAbi for CustomEvent

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, extra: &mut dyn Stack) -> Self

Recover a Self from Self::Abi.

impl WasmDescribe for CustomEvent

fn describe()

impl IntoWasmAbi for CustomEvent

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

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

impl<'a> IntoWasmAbi for &'a CustomEvent

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

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

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

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

impl OptionIntoWasmAbi for CustomEvent

fn none() -> Self::Abi

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

impl<'a> OptionIntoWasmAbi for &'a CustomEvent

fn none() -> Self::Abi

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

impl OptionFromWasmAbi for CustomEvent

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

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<CustomEvent>

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, extra: &mut dyn Stack) -> Self::Anchor

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