Struct KeyedSubfield

pub struct KeyedSubfield<Inner, Prev, K, T>
where
    for<'a> &'a T: IntoIterator,
{ /* private fields */ }

Provides access to a subfield that contains some kind of keyed collection.

Implementations

impl<Inner, Prev, K, T> KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator,

pub fn new( inner: Inner, path_segment: StorePathSegment, key_fn: fn(_: <&T as IntoIterator>::Item) -> K, read: fn(_: &Prev) -> &T, write: fn(_: &mut Prev) -> &mut T, ) -> Self

Creates a keyed subfield of the inner data type with the given key function.

impl<Inner, Prev, K, T> KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev>, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

pub fn update_keys(&self)

Generates a new set of keys and registers those keys with the parent store.

Trait Implementations

impl<Inner, Prev, K, T> Clone for KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator, Inner: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Inner: Debug, Prev: Debug, K: Debug, T: Debug> Debug for KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator,

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

Formats the value using the given formatter.

impl<Inner, Prev, K, T> DefinedAt for KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev>,

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<Inner, Prev, K, T> IntoIterator for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: Clone + StoreField<Value = Prev> + 'static, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static, T: IndexMut<usize> + 'static, T::Output: Sized,

type Item = AtKeyed<Inner, Prev, K, T>

The type of the elements being iterated over.

type IntoIter = StoreFieldKeyedIter<Inner, Prev, K, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> StoreFieldKeyedIter<Inner, Prev, K, T>

Creates an iterator from a value.

impl<Inner, Prev, K, T> IsDisposed for KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator, Inner: IsDisposed,

fn is_disposed(&self) -> bool

If true, the signal cannot be accessed without a panic.

impl<Inner, Prev, K, T> Notify for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev>, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

fn notify(&self)

Notifies subscribers of a change in this signal.

impl<Inner, Prev, K, T> ReadUntracked for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev>, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

type Value = <KeyedSubfield<Inner, Prev, K, T> as StoreField>::Reader

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

fn try_read_untracked(&self) -> Option<Self::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<Inner, Prev, K, T> StoreField for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev>, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

type Value = T

The value this field contains.

type Reader = Mapped<<Inner as StoreField>::Reader, T>

A read guard to access this field.

type Writer = MappedMut<WriteGuard<ArcTrigger, <Inner as StoreField>::Writer>, T>

A write guard to update this field.

fn path(&self) -> impl IntoIterator<Item = StorePathSegment>

The path of this field (see StorePath).

fn get_trigger(&self, path: StorePath) -> StoreFieldTrigger

Returns the trigger that tracks access and updates for this field.

fn reader(&self) -> Option<Self::Reader>

Returns a read guard to access this field.

fn writer(&self) -> Option<Self::Writer>

Returns a write guard to update this field.

fn keys(&self) -> Option<KeyMap>

The keys for this field, if it is a keyed field.

fn track_field(&self)

Reactively tracks this field.

impl<Inner, Prev, K, T> Track for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, Inner: StoreField<Value = Prev> + Track + 'static, Prev: 'static, T: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

fn track(&self)

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

impl<Inner, Prev, K, T> Write for KeyedSubfield<Inner, Prev, K, T>

where Self: Clone, for<'a> &'a T: IntoIterator, T: 'static, Inner: StoreField<Value = Prev>, Prev: 'static, K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,

type Value = T

The type of the signal’s value.

fn try_write(&self) -> Option<impl UntrackableGuard<Target = Self::Value>>

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

fn try_write_untracked(&self) -> Option<impl DerefMut<Target = Self::Value>>

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<Inner, Prev, K, T> Copy for KeyedSubfield<Inner, Prev, K, T>

where for<'a> &'a T: IntoIterator, Inner: Copy,