Skip to main content

ArcField

Struct ArcField 

Source
pub struct ArcField<T>
where T: 'static,
{ /* private fields */ }
Expand description

Reference-counted access to a single field of type T.

This can be used to erase the chain of field-accessors, to make it easier to pass this into another component or function without needing to specify the full type signature.

Trait Implementations§

Source§

impl<T> Clone for ArcField<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for ArcField<T>
where T: 'static,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> DefinedAt for ArcField<T>

Source§

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

impl<T, S> From<ArcField<T>> for Field<T, S>
where T: 'static, S: Storage<ArcField<T>>,

Source§

fn from(value: ArcField<T>) -> Self

Converts to this type from the input type.
Source§

impl<T> From<ArcStore<T>> for ArcField<T>
where T: Send + Sync + 'static,

Source§

fn from(value: ArcStore<T>) -> Self

Converts to this type from the input type.
Source§

impl<Inner, Prev> From<AtIndex<Inner, Prev>> for ArcField<Prev::Output>
where AtIndex<Inner, Prev>: Clone, Inner: StoreField<Value = Prev> + IsDisposed + Send + Sync + 'static, Prev: IndexMut<usize> + Len + Send + Sync + 'static, Prev::Output: Sized + Send + Sync,

Source§

fn from(value: AtIndex<Inner, Prev>) -> Self

Converts to this type from the input type.
Source§

impl<Inner, Prev, K, T> From<AtKeyed<Inner, Prev, K, T>> for ArcField<T::Value>
where AtKeyed<Inner, Prev, K, T>: Clone, K: Clone + Debug + Send + Sync + PartialEq + Eq + Hash + 'static, KeyedSubfield<Inner, Prev, K, T>: Clone, T: KeyedIterable + KeyedAccess<K> + 'static, for<'a> &'a T: IntoIterator<Item = <T as KeyedIterable>::IterItem<'a>>, Inner: StoreField<Value = Prev> + IsDisposed + Send + Sync + 'static, Prev: 'static, T::Value: Sized,

Source§

fn from(value: AtKeyed<Inner, Prev, K, T>) -> Self

Converts to this type from the input type.
Source§

impl<Inner, T> From<DerefedField<Inner>> for ArcField<T>
where Inner: Clone + StoreField + IsDisposed + Send + Sync + 'static, Inner::Value: Deref<Target = T> + DerefMut, T: Sized + 'static,

Source§

fn from(value: DerefedField<Inner>) -> Self

Converts to this type from the input type.
Source§

impl<T, S> From<Store<T, S>> for ArcField<T>
where T: 'static, S: Storage<ArcStore<T>>,

Source§

fn from(value: Store<T, S>) -> Self

Converts to this type from the input type.
Source§

impl<Inner, Prev, T> From<Subfield<Inner, Prev, T>> for ArcField<T>
where T: Send + Sync, Subfield<Inner, Prev, T>: Clone, Inner: StoreField<Value = Prev> + IsDisposed + Send + Sync + 'static, Prev: 'static,

Source§

fn from(value: Subfield<Inner, Prev, T>) -> Self

Converts to this type from the input type.
Source§

impl<T> IsDisposed for ArcField<T>

Source§

fn is_disposed(&self) -> bool

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

impl<T> Notify for ArcField<T>

Source§

fn notify(&self)

Notifies subscribers of a change in this signal.
Source§

impl<T> ReadUntracked for ArcField<T>

Source§

type Value = StoreFieldReader<T>

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

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

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

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

Returns the guard. Read more
Source§

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. Read more
Source§

impl<V> SignalOrFn for ArcField<V>
where ArcField<V>: Get<Value = V>,

Source§

type Output = V

The value produced (reactively) when invoked.
Source§

fn run(&self) -> V

Reactively read the current value (subscribes the active observer).
Source§

impl<T> StoreField for ArcField<T>

Source§

type Value = T

The value this field contains.
Source§

type Reader = StoreFieldReader<T>

A read guard to access this field.
Source§

type Writer = StoreFieldWriter<T>

A write guard to update this field.
Source§

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

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

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

Returns the trigger that tracks access and updates for this field. Read more
Source§

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

The path of this field (see StorePath).
Source§

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

The path of this field (see StorePath). Uses unkeyed indices for any keyed fields.
Source§

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

Returns a read guard to access this field.
Source§

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

Returns a write guard to update this field.
Source§

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

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

fn track_field(&self)

Reactively tracks this field.
Source§

fn triggers_for_current_path(&self) -> Vec<ArcTrigger>

Returns triggers for this field, and all parent fields.
Source§

fn triggers_for_path(&self, path: StorePath) -> Vec<ArcTrigger>

Returns triggers for the field at the given path, and all parent fields
Source§

fn triggers_for_path_unkeyed(&self, path: StorePath) -> Vec<ArcTrigger>

Returns triggers for the field at the given path, and all parent fields
Source§

impl<T> Track for ArcField<T>

Source§

fn track(&self)

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

impl<T> Write for ArcField<T>

Source§

type Value = T

The type of the signal’s value.
Source§

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

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

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

or None if the signal has already been disposed.
Source§

fn write(&self) -> impl UntrackableGuard

Returns the guard. Read more
Source§

fn write_untracked(&self) -> impl DerefMut

Returns a guard that will not notify subscribers when dropped. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for ArcField<T>

§

impl<T> !UnwindSafe for ArcField<T>

§

impl<T> Freeze for ArcField<T>

§

impl<T> Send for ArcField<T>

§

impl<T> Sync for ArcField<T>

§

impl<T> Unpin for ArcField<T>

§

impl<T> UnsafeUnpin for ArcField<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read for T
where T: Track + ReadUntracked,

Source§

type Value = <T as ReadUntracked>::Value

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

fn try_read(&self) -> Option<<T as Read>::Value>

Subscribes to the signal, and returns the guard, or None if the signal has already been disposed.
Source§

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

Subscribes to the signal, and returns the guard. Read more
Source§

impl<T> Set for T
where T: Update + IsDisposed,

Source§

type Value = <T as Update>::Value

The type of the value contained in the signal.
Source§

fn set(&self, value: <T as Set>::Value)

Updates the value by replacing it, and notifies subscribers that it has changed.
Source§

fn try_set(&self, value: <T as Set>::Value) -> Option<<T as Set>::Value>

Updates the value by replacing it, and notifies subscribers that it has changed. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<Inner, Prev> StoreFieldIterator<Prev> for Inner
where Inner: StoreField<Value = Prev> + Clone, <Prev as Index<usize>>::Output: Sized, Prev: IndexMut<usize> + Len,

Source§

fn at_unkeyed(self, index: usize) -> AtIndex<Inner, Prev>

Reactive access to the value at some index.
Source§

fn iter_unkeyed(self) -> StoreFieldIter<Inner, Prev>

An iterator over the values in the collection.
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.
Source§

impl<T> Update for T
where T: Write,

Source§

type Value = <T as Write>::Value

The type of the value contained in the signal.
Source§

fn try_maybe_update<U>( &self, fun: impl FnOnce(&mut <T as Update>::Value) -> (bool, U), ) -> Option<U>

Updates the value of the signal, notifying subscribers if the update function returns (true, _), and returns the value returned by the update function, or None if the signal has already been disposed.
Source§

fn update(&self, fun: impl FnOnce(&mut Self::Value))

Updates the value of the signal and notifies subscribers.
Source§

fn maybe_update(&self, fun: impl FnOnce(&mut Self::Value) -> bool)

Updates the value of the signal, but only notifies subscribers if the function returns true.
Source§

fn try_update<U>(&self, fun: impl FnOnce(&mut Self::Value) -> U) -> Option<U>

Updates the value of the signal and notifies subscribers, returning the value that is returned by the update function, or None if the signal has already been disposed.
Source§

impl<T> UpdateUntracked for T
where T: Write,

Source§

type Value = <T as Write>::Value

The type of the value contained in the signal.
Source§

fn try_update_untracked<U>( &self, fun: impl FnOnce(&mut <T as UpdateUntracked>::Value) -> U, ) -> Option<U>

Updates the value by applying a function, returning the value returned by that function, or None if the signal has already been disposed. Does not notify subscribers that the signal has changed.
Source§

fn update_untracked<U>(&self, fun: impl FnOnce(&mut Self::Value) -> U) -> U

Updates the value by applying a function, returning the value returned by that function. Does not notify subscribers that the signal has changed. Read more
Source§

impl<T> With for T
where T: Read,

Source§

type Value = <<T as Read>::Value as Deref>::Target

The type of the value contained in the signal.
Source§

fn try_with<U>(&self, fun: impl FnOnce(&<T as With>::Value) -> U) -> Option<U>

Subscribes to the signal, applies the closure to the value, and returns the result, or None if the signal has already been disposed.
Source§

fn with<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U

Subscribes to the signal, applies the closure to the value, and returns the result. Read more
Source§

impl<T> WithUntracked for T

Source§

type Value = <<T as ReadUntracked>::Value as Deref>::Target

The type of the value contained in the signal.
Source§

fn try_with_untracked<U>( &self, fun: impl FnOnce(&<T as WithUntracked>::Value) -> U, ) -> Option<U>

Applies the closure to the value, and returns the result, or None if the signal has already been disposed.
Source§

fn with_untracked<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U

Applies the closure to the value, and returns the result. Read more