pub struct EventHandler<T = ()> { /* private fields */ }
Expand description

The callback type generated by the rsx! macro when an on field is specified for components.

This makes it possible to pass move |evt| {} style closures into components as property fields.

§Example

rsx!{
    MyComponent { onclick: move |evt| tracing::debug!("clicked") }
}

#[derive(Props)]
struct MyProps {
    onclick: EventHandler<MouseEvent>,
}

fn MyComponent(cx: MyProps) -> Element {
    rsx!{
        button {
            onclick: move |evt| cx.onclick.call(evt),
        }
    }
}

Implementations§

source§

impl<T> EventHandler<T>
where T: 'static,

source

pub fn new(f: impl FnMut(T) + 'static) -> EventHandler<T>

Create a new EventHandler from an FnMut

source

pub fn call(&self, event: T)

Call this event handler with the appropriate event type

This borrows the event using a RefCell. Recursively calling a listener will cause a panic.

source

pub fn release(&self)

Forcibly drop the internal handler callback, releasing memory

This will force any future calls to “call” to not doing anything

Trait Implementations§

source§

impl<T> Clone for EventHandler<T>

source§

fn clone(&self) -> EventHandler<T>

Returns a copy 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<T> Default for EventHandler<T>
where T: 'static,

source§

fn default() -> EventHandler<T>

Returns the “default value” for a type. Read more
source§

impl<T> Deref for EventHandler<T>
where T: 'static,

§

type Target = dyn Fn(T)

The resulting type after dereferencing.
source§

fn deref(&self) -> &<EventHandler<T> as Deref>::Target

Dereferences the value.
source§

impl<F, T> From<F> for EventHandler<T>
where F: FnMut(T) + 'static, T: 'static,

source§

fn from(f: F) -> EventHandler<T>

Converts to this type from the input type.
source§

impl<T> PartialEq for EventHandler<T>
where T: 'static,

source§

fn eq(&self, _: &EventHandler<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T> Copy for EventHandler<T>

Auto Trait Implementations§

§

impl<T> Freeze for EventHandler<T>

§

impl<T = ()> !RefUnwindSafe for EventHandler<T>

§

impl<T = ()> !Send for EventHandler<T>

§

impl<T = ()> !Sync for EventHandler<T>

§

impl<T> Unpin for EventHandler<T>

§

impl<T = ()> !UnwindSafe for EventHandler<T>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, O> SuperFrom<T> for O
where O: From<T>,

source§

fn super_from(input: T) -> O

Convert from a type to another type.
source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

source§

fn super_into(self) -> O

Convert from a type to another type.
source§

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

source§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
source§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
source§

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

§

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>,

§

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>,

§

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.
source§

impl<Cfg> TryIntoConfig for Cfg

source§

fn into_config(self) -> Option<Cfg>

Available on crate feature launch only.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,