ListEntry

Struct ListEntry 

Source
pub struct ListEntry<T>(/* private fields */);
Expand description

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§

Source§

impl<T> ListEntry<T>

Source

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.

Source

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.

Source

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§

Source§

impl<T> Clone for ListEntry<T>

Source§

fn clone(&self) -> Self

Returns a duplicate 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> PartialEq for ListEntry<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl<T> Freeze for ListEntry<T>

§

impl<T> !RefUnwindSafe for ListEntry<T>

§

impl<T> Send for ListEntry<T>
where T: Send + Sync,

§

impl<T> Sync for ListEntry<T>
where T: Send + Sync,

§

impl<T> Unpin for ListEntry<T>

§

impl<T> !UnwindSafe for ListEntry<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

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

Source§

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

Source§

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.