Struct lignin::EventBindingOptions [−][src]
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
[src]
impl EventBindingOptions
[src]#[must_use]pub fn deanonymize(self) -> Self
[src]
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
[src]
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 alwaysThreadSafe
.
#[must_use]pub fn prefer_thread_safe_ref(&self) -> &Self
[src]
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 alwaysThreadSafe
.
impl EventBindingOptions
[src]
impl EventBindingOptions
[src]#[must_use]pub const fn new() -> Self
[src]
Creates a new EventBindingOptions
instance with [.passive()
] already set to true
.
#[must_use]pub const fn capture(&self) -> bool
[src]
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)
[src]
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
[src]
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
[src]
Indicates whether an associated CallbackRef
should be invoked at most once for this EventBinding
. See more.
pub fn set_once(&mut self, once: bool)
[src]
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
[src]
Sets whether an associated CallbackRef
should be invoked at most once for this EventBinding
. See more.
#[must_use]pub const fn passive(&self) -> bool
[src]
(default)
Indicates whether a callback is disallowed from calling web_sys::Event::prevent_default()
.
See more.
pub fn set_passive(&mut self, passive: bool)
[src]
(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
[src]
(default)
Sets whether a callback is disallowed from calling web_sys::Event::prevent_default()
.
See more.
Trait Implementations
impl Clone for EventBindingOptions
[src]
impl Clone for EventBindingOptions
[src]fn clone(&self) -> EventBindingOptions
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for EventBindingOptions
[src]
impl Copy for EventBindingOptions
[src]impl Default for EventBindingOptions
[src]
impl Default for EventBindingOptions
[src]fn default() -> Self
[src]
Creates a new EventBindingOptions
instance with [.passive()
] already set to true
. See more.
impl Eq for EventBindingOptions
[src]
impl Eq for EventBindingOptions
[src]impl Hash for EventBindingOptions
[src]
impl Hash for EventBindingOptions
[src]impl Ord for EventBindingOptions
[src]
impl Ord for EventBindingOptions
[src]impl PartialEq<EventBindingOptions> for EventBindingOptions
[src]
impl PartialEq<EventBindingOptions> for EventBindingOptions
[src]fn eq(&self, other: &EventBindingOptions) -> bool
[src]
fn ne(&self, other: &EventBindingOptions) -> bool
[src]
impl PartialOrd<EventBindingOptions> for EventBindingOptions
[src]
impl PartialOrd<EventBindingOptions> for EventBindingOptions
[src]fn partial_cmp(&self, other: &EventBindingOptions) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for EventBindingOptions
[src]
impl StructuralEq for EventBindingOptions
[src]impl Vdom for EventBindingOptions
[src]
impl Vdom for EventBindingOptions
[src]type ThreadSafety = ThreadSafe
The ThreadSafety
of the Vdom
type, either ThreadSafe
or ThreadBound
. Read more
Auto Trait Implementations
impl RefUnwindSafe for EventBindingOptions
impl RefUnwindSafe for EventBindingOptions
impl Send for EventBindingOptions
impl Send for EventBindingOptions
impl Sync for EventBindingOptions
impl Sync for EventBindingOptions
impl Unpin for EventBindingOptions
impl Unpin for EventBindingOptions
impl UnwindSafe for EventBindingOptions
impl UnwindSafe for EventBindingOptions