Skip to main content

SyntheticEvent

Struct SyntheticEvent 

Source
pub struct SyntheticEvent {
    pub event_type: EventType,
    pub source: EventSource,
    pub phase: EventPhase,
    pub target: DomNodeId,
    pub current_target: DomNodeId,
    pub timestamp: Instant,
    pub data: EventData,
    pub stopped: bool,
    pub stopped_immediate: bool,
    pub prevented_default: bool,
}
Expand description

Unified event wrapper (similar to React’s SyntheticEvent).

All events in the system are wrapped in this structure, providing a consistent interface and enabling event propagation control.

Fields§

§event_type: EventType

The type of event

§source: EventSource

Where the event came from

§phase: EventPhase

Current propagation phase

§target: DomNodeId

Target node that the event was dispatched to

§current_target: DomNodeId

Current node in the propagation path

§timestamp: Instant

Timestamp when event was created

§data: EventData

Type-specific event data

§stopped: bool

Whether propagation has been stopped

§stopped_immediate: bool

Whether immediate propagation has been stopped

§prevented_default: bool

Whether default action has been prevented

Implementations§

Source§

impl SyntheticEvent

Source

pub fn new( event_type: EventType, source: EventSource, target: DomNodeId, timestamp: Instant, data: EventData, ) -> Self

Create a new synthetic event.

§Parameters
  • timestamp: Current time from (system_callbacks.get_system_time_fn.cb)()
Source

pub fn stop_propagation(&mut self)

Stop event propagation after the current phase completes.

This prevents the event from reaching handlers in subsequent phases (e.g., stopping during capture prevents bubble phase).

Source

pub fn stop_immediate_propagation(&mut self)

Stop event propagation immediately.

This prevents any further handlers from being called, even on the current target element.

Source

pub fn prevent_default(&mut self)

Prevent the default action associated with this event.

For example, prevents form submission on Enter key, or prevents text selection on drag.

Source

pub fn is_propagation_stopped(&self) -> bool

Check if propagation was stopped.

Source

pub fn is_immediate_propagation_stopped(&self) -> bool

Check if immediate propagation was stopped.

Source

pub fn is_default_prevented(&self) -> bool

Check if default action was prevented.

Trait Implementations§

Source§

impl Clone for SyntheticEvent

Source§

fn clone(&self) -> SyntheticEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyntheticEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SyntheticEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SyntheticEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.