Struct SignalSetter

pub struct SignalSetter<T, S = SyncStorage>
where
    T: 'static,
{ /* private fields */ }

A wrapper for any kind of settable reactive signal: a WriteSignal, RwSignal, or closure that receives a value and sets a signal depending on it.

This allows you to create APIs that take any kind of SignalSetter<T> as an argument, rather than adding a generic F: Fn(T). Values can be set with the same function call or set(), API as other signals.

Core Trait Implementations

• .set() (or calling the setter as a function) sets the signal’s value, and notifies all subscribers that the signal’s value has changed. to subscribe to the signal, and to re-run whenever the value of the signal changes.

Examples

let (count, set_count) = signal(2);
let set_double_input = SignalSetter::map(move |n| set_count.set(n * 2));

// this function takes any kind of signal setter
fn set_to_4(setter: &SignalSetter<i32>) {
    // ✅ calling the signal sets the value
    //    can be `setter(4)` on nightly
    setter.set(4);
}

set_to_4(&set_count.into());
assert_eq!(count.get(), 4);
set_to_4(&set_double_input);
assert_eq!(count.get(), 8);

Implementations

impl<T, S> SignalSetter<T, S>

where S: Storage<Box<dyn Fn(T) + Send + Sync>>,

pub fn map(mapped_setter: impl Fn(T) + Send + Sync + 'static) -> Self

Wraps a signal-setting closure, i.e., any computation that sets one or more reactive signals.

Trait Implementations

impl<T, S> Clone for SignalSetter<T, S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S: Debug> Debug for SignalSetter<T, S>

where T: 'static + Debug,

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

Formats the value using the given formatter.

impl<T: Default + 'static, S> Default for SignalSetter<T, S>

fn default() -> Self

Returns the “default value” for a type.

impl<T, S> Fn(T) for SignalSetter<T, S>

where SignalSetter<T, S>: Set<Value = T>,

extern "rust-call" fn call(&self, args: (T,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T, S> FnMut(T) for SignalSetter<T, S>

where SignalSetter<T, S>: Set<Value = T>,

extern "rust-call" fn call_mut(&mut self, args: (T,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T, S> FnOnce(T) for SignalSetter<T, S>

where SignalSetter<T, S>: Set<Value = T>,

type Output = ()

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, args: (T,)) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T, S> From<RwSignal<T, S>> for SignalSetter<T, S>

where T: Send + Sync + 'static, S: Storage<ArcRwSignal<T>> + Storage<ArcWriteSignal<T>>,

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

Converts to this type from the input type.

impl<T, S> From<WriteSignal<T, S>> for SignalSetter<T, S>

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

Converts to this type from the input type.

impl<T, S: PartialEq> PartialEq for SignalSetter<T, S>

where T: 'static + PartialEq,

fn eq(&self, other: &SignalSetter<T, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, S> Set for SignalSetter<T, S>

where T: 'static, S: Storage<ArcWriteSignal<T>> + Storage<Box<dyn Fn(T) + Send + Sync>>,

type Value = T

The type of the value contained in the signal.

fn set(&self, new_value: Self::Value)

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

fn try_set(&self, new_value: Self::Value) -> Option<Self::Value>

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

impl<T, S> Copy for SignalSetter<T, S>

impl<T, S: Eq> Eq for SignalSetter<T, S>

where T: 'static + Eq,

impl<T, S> StructuralPartialEq for SignalSetter<T, S>

where T: 'static,