Struct dioxus_shareables::list::ListEntry

pub struct ListEntry<T>(_);

A pointer to an element from a List

Note that this cannot be used directly to get access to the value in the list. Instead, one must use either one of the methods use_w or use_rw.

ListEntry implements PartialEq AS A POINTER ONLY. This is so that the properties of a component depend only on which list entry is referenced, and not on the value.

Implementations

impl<T> ListEntry<T>

pub fn share(&self) -> Shared<T, W>

Get a write-only pointer to the element.

This is generally how an entry is accessed from the component which owns its List. If the entry was passed down from a parent component, then you generally want to call use_w or use_rw instead.

pub fn use_w<'a, P>(&self, cx: &Scope<'a, P>) -> &'a mut Shared<T, W>

Get a write pointer to the element as a hook.

This is the expected way to get write-only access to an entry when it is passed down from a parent component. If you need to access an entry in the component which owns the list it belongs to, then you generally need to use share instead.

pub fn use_rw<'a, P>(&self, cx: &Scope<'a, P>) -> &'a mut Shared<T, RW>

Get a read-write pointer to the element.

Scope cx will be registered as needing update every time the referenced value changes.

This is the expected ways to get read/write access an entry when it is passed down from a parent component. If you need to access an entry in the component which owns the list it belongs to, then you generally need to use share instead.

Trait Implementations

impl<T> Clone for ListEntry<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> PartialEq<ListEntry<T>> for ListEntry<T>

fn eq(&self, o: &Self) -> bool

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

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.