Struct MappedSignal

pub struct MappedSignal<T, S = SyncStorage> { /* private fields */ }

A derived signal type that wraps an RwSignal with a mapping function, allowing you to read or write directly to one of its field.

Tracking the mapped signal tracks changes to any part of the signal, and updating the signal notifies and notifies all dependencies of the signal. This is not a mechanism for fine-grained reactive updates to more complex data structures. Instead, it allows you to provide a signal-like API for wrapped types without exposing the original type directly to users.

Implementations

impl<T> MappedSignal<T>

pub fn new<U>( inner: RwSignal<U>, map: fn(&U) -> &T, map_mut: fn(&mut U) -> &mut T, ) -> Self

where T: Send + Sync + 'static, U: Send + Sync + 'static,

Wraps a signal with the given mapping functions for shared and exclusive references.

Trait Implementations

impl<T> Clone for MappedSignal<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MappedSignal<T>

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

Formats the value using the given formatter.

impl<T> DefinedAt for MappedSignal<T>

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<T> From<ArcMappedSignal<T>> for MappedSignal<T>

where T: 'static,

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

Converts to this type from the input type.

impl<T> From<MappedSignal<T>> for Signal<T>

where T: Clone + Send + Sync + 'static,

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

Converts to this type from the input type.

impl<T> IsDisposed for MappedSignal<T>

fn is_disposed(&self) -> bool

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

impl<T> Notify for MappedSignal<T>

where T: 'static,

fn notify(&self)

Notifies subscribers of a change in this signal.

impl<T> ReadUntracked for MappedSignal<T>

where T: 'static,

type Value = DoubleDeref<Box<dyn Deref<Target = T>>>

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<T> Track for MappedSignal<T>

where T: 'static,

fn track(&self)

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

impl<T> Write for MappedSignal<T>

where T: 'static,

type Value = T

The type of the signal’s value.

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

or None if the signal has already been disposed.

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

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

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

Returns the guard.

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

Returns a guard that will not notify subscribers when dropped.

impl<T> Copy for MappedSignal<T>