Struct lignin::EventBindingOptions

pub struct EventBindingOptions(_);

Vdom Maps to options parameter values of EventTarget.addEventListener().

Note that all constructors initialize instances with .passive() set to true.

Also note that these flags aren’t part of any soundness contract! Don’t rely on them for memory safety.

Flags

capture

Controls whether a web::Event should be dispatched while bubbling down rather than up along the DOM.

once

Controls whether an associated CallbackRef should be invoked at most once for this EventBinding.

This carries over for as long as the EventBinding’s VDOM identity doesn’t change.

passive (default)

Controls whether a callback is disallowed from calling web_sys::Event::prevent_default().

Calling that method while this flag is enabled shouldn’t produce any effects other than printing a warning to a browser’s JavaScript console.

This flag can significantly improve performance when applied to certain events.

passive: true isn’t always the default in web browsers for backwards compatibility reasons.

As lignin is a new framework, it’s able to break with that tradition for more consistency and a better default.

Implementations

impl EventBindingOptions

#[must_use]

pub fn deanonymize(self) -> Self

👎 Deprecated:

Call of .deanonymize() on named type.

When called on an opaque type, deanonymizes it into the underlying named type.

Both AutoSafe and Deanonymize must be in scope and the method must be called without qualification for this to work.

Calling this method on a named type returns the value and type unchanged and produces a deprecation warning.

#[must_use]

pub fn prefer_thread_safe(self) -> Self

👎 Deprecated:

Call of .prefer_thread_safe() on EventBindingOptions.

Gently nudges the compiler to choose the ThreadSafe version of a value if both are possible.

This method is by value, so it will resolve with higher priority than the by-reference method on the ThreadBound type.

Note that not all tooling will show the correct overload here, but the compiler knows which to pick.

Calling this method on EventBindingOptions produces a deprecation warning since the type is always ThreadSafe.

#[must_use]

pub fn prefer_thread_safe_ref(&self) -> &Self

👎 Deprecated:

Call of .prefer_thread_safe_ref() on EventBindingOptions.

Gently nudges the compiler to choose the ThreadSafe version of a reference if both are possible.

This method is once by single reference, so it will resolve with higher priority than the twice-by-reference method on the ThreadBound type.

Note that not all tooling will show the correct overload here, but the compiler knows which to pick.

Calling this method on EventBindingOptions produces a deprecation warning since the type is always ThreadSafe.

impl EventBindingOptions

#[must_use]

pub const fn new() -> Self

Creates a new EventBindingOptions instance with [.passive()] already set to true.

#[must_use]

pub const fn capture(&self) -> bool

Indicates whether a web::Event should be dispatched while bubbling down rather than up along the DOM.

pub fn set_capture(&mut self, capture: bool)

Sets whether a web::Event should be dispatched while bubbling down rather than up along the DOM.

#[must_use]

pub const fn with_capture(self, capture: bool) -> Self

Sets whether a web::Event should be dispatched while bubbling down rather than up along the DOM.

#[must_use]

pub const fn once(&self) -> bool

Indicates whether an associated CallbackRef should be invoked at most once for this EventBinding. See more.

pub fn set_once(&mut self, once: bool)

Sets whether an associated CallbackRef should be invoked at most once for this EventBinding. See more.

#[must_use]

pub const fn with_once(self, once: bool) -> Self

Sets whether an associated CallbackRef should be invoked at most once for this EventBinding. See more.

#[must_use]

pub const fn passive(&self) -> bool

(default) Indicates whether a callback is disallowed from calling web_sys::Event::prevent_default(). See more.

pub fn set_passive(&mut self, passive: bool)

(default) Sets whether a callback is disallowed from calling web_sys::Event::prevent_default(). See more.

#[must_use]

pub const fn with_passive(self, passive: bool) -> Self

(default) Sets whether a callback is disallowed from calling web_sys::Event::prevent_default(). See more.

Trait Implementations

impl Clone for EventBindingOptions

fn clone(&self) -> EventBindingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventBindingOptions

impl Debug for EventBindingOptions

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

Formats the value using the given formatter.

impl Default for EventBindingOptions

fn default() -> Self

Creates a new EventBindingOptions instance with [.passive()] already set to true. See more.

impl Eq for EventBindingOptions

impl Hash for EventBindingOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for EventBindingOptions

fn cmp(&self, other: &EventBindingOptions) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EventBindingOptions> for EventBindingOptions

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

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

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

This method tests for !=.

impl PartialOrd<EventBindingOptions> for EventBindingOptions

fn partial_cmp(&self, other: &EventBindingOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for EventBindingOptions

impl StructuralPartialEq for EventBindingOptions

impl Vdom for EventBindingOptions

type ThreadSafety = ThreadSafe

The ThreadSafety of the Vdom type, either ThreadSafe or ThreadBound.