Struct NodeRef

pub struct NodeRef<E>(/* private fields */)
where
    E: ElementType,
    <E as ElementType>::Output: 'static;

A reactive reference to a DOM node that can be used with the node_ref attribute.

Implementations

impl<E> NodeRef<E>

where E: ElementType, <E as ElementType>::Output: 'static,

pub fn new() -> NodeRef<E>

Creates a new node reference.

pub fn on_load<F>(self, f: F)

where E: 'static + ElementType, F: FnOnce(<E as ElementType>::Output) + 'static, <E as ElementType>::Output: JsCast + Clone + 'static,

Runs the provided closure when the NodeRef has been connected with its element.

Trait Implementations

impl<E> Clone for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: 'static,

fn clone(&self) -> NodeRef<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> Debug for NodeRef<E>

where E: Debug + ElementType, <E as ElementType>::Output: 'static + Debug,

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

Formats the value using the given formatter.

impl<E> Default for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: 'static,

fn default() -> NodeRef<E>

Returns the “default value” for a type.

impl<E> DefinedAt for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + 'static,

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.

impl<E> NodeRefContainer<E> for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + 'static,

fn load(self, el: &Element)

Fills the container with the element.

impl<E> Notify for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + Clone + 'static,

fn notify(&self)

Notifies subscribers of a change in this signal.

impl<E> ReadUntracked for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + Clone + 'static,

type Value = ReadGuard<Option<<E as ElementType>::Output>, Derefable<Option<<E as ElementType>::Output>>>

The guard type that will be returned, which can be dereferenced to the value.

fn try_read_untracked(&self) -> Option<<NodeRef<E> as ReadUntracked>::Value>

Returns the guard, or None if the signal has already been disposed.

fn read_untracked(&self) -> Self::Value

Returns the guard.

fn custom_try_read(&self) -> Option<Option<Self::Value>>

This is a backdoor to allow overriding the Read::try_read implementation despite it being auto implemented.

impl<E> Track for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + 'static,

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.

impl<E> Write for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: JsCast + Clone + 'static,

type Value = Option<SendWrapper<<E as ElementType>::Output>>

The type of the signal’s value.

fn try_write(&self) -> Option<impl UntrackableGuard>

Returns the guard, or None if the signal has already been disposed.

fn try_write_untracked(&self) -> Option<impl DerefMut>

or None if the signal has already been disposed.

fn write(&self) -> impl UntrackableGuard

Returns the guard.

fn write_untracked(&self) -> impl DerefMut

Returns a guard that will not notify subscribers when dropped.

impl<E> Copy for NodeRef<E>

where E: ElementType, <E as ElementType>::Output: 'static,