Struct sycamore_reactive::Signal

pub struct Signal<T>(_);

A container of reactive state that can be updated and subscribed to.

Example

Creating a Signal requires a reactive Scope. Generally, you can use the cx parameter obtained from your component or from inside a create_effect_scoped.

let signal = create_signal(cx, 123);    // A signal of type `i32`.
let signal = create_signal(cx, true);   // A signal of type `bool`.
let signal = create_signal(cx, "abc");  // A signal of type `&str`.

Implementations

impl<T> Signal<T>

pub fn set(&self, value: T)

Set the current value of the state.

This will notify and update any effects and memos that depend on this value.

Example

let state = create_signal(cx, 0);
assert_eq!(*state.get(), 0);

state.set(1);
assert_eq!(*state.get(), 1);

pub fn set_rc(&self, value: Rc<T>)

Set the current value of the state wrapped in a Rc. Unlike Signal::set(), this method accepts the value wrapped in a Rc because the underlying storage is already using Rc, thus preventing an unnecessary clone.

This will notify and update any effects and memos that depend on this value.

Example

let state = create_signal(cx, 0);
assert_eq!(*state.get(), 0);

state.set_rc(Rc::new(1));
assert_eq!(*state.get(), 1);

pub fn set_silent(&self, value: T)

Set the current value of the state without triggering subscribers.

Make sure you know what you are doing because this can make state inconsistent.

pub fn set_rc_silent(&self, value: Rc<T>)

Set the current value of the state wrapped in a Rc without triggering subscribers.

See the documentation for Signal::set_rc() for more information.

Make sure you know what you are doing because this can make state inconsistent.

pub fn split(&self) -> (impl Fn() -> Rc<T> + Copy + '_, impl Fn(T) + Copy + '_)

Split a signal into getter and setter handles.

Example

let (state, set_state) = create_signal(cx, 0).split();
assert_eq!(*state(), 0);

set_state(1);
assert_eq!(*state(), 1);

pub fn trigger_subscribers(&self)

Calls all the subscribers without modifying the state. This can be useful when using patterns such as inner mutability where the state updated will not be automatically triggered. In the general case, however, it is preferable to use Signal::set() instead.

This will also re-compute all the subscribers of this signal by calling all the dependency callbacks.

impl<T: Clone> Signal<T>

pub fn modify(&self) -> Modify<'_, T>

Return a mutable handle to make it easier to mutate the inner value. This requires the inner type to implement Clone.

Example

let state = create_signal(cx, "Hello ".to_string());
state.modify().push_str("World!");
assert_eq!(*state.get(), "Hello World!");

impl<T: Default> Signal<T>

pub fn take(&self) -> Rc<T>

Take the current value out and replace it with the default value.

This will notify and update any effects and memos that depend on this value.

pub fn take_silent(&self) -> Rc<T>

Take the current value out and replace it with the default value without triggering subscribers.

Make sure you know what you are doing because this can make state inconsistent.

Methods from Deref<Target = ReadSignal<T>>

pub fn get(&self) -> Rc<T>

Get the current value of the state. When called inside a reactive scope, calling this will add itself to the scope’s dependencies.

Example

let state = create_signal(cx, 0);
assert_eq!(*state.get(), 0);

state.set(1);
assert_eq!(*state.get(), 1);

pub fn get_untracked(&self) -> Rc<T>

Get the current value of the state, without tracking this as a dependency if inside a reactive context.

Example

let state = create_signal(cx, 1);
let double = create_memo(cx, || *state.get_untracked() * 2);
assert_eq!(*double.get(), 2);

state.set(2);
// double value should still be old value because state was untracked
assert_eq!(*double.get(), 2);

pub fn map<'a, U>(
    &'a self,
    cx: Scope<'a>,
    f: impl FnMut(&T) -> U + 'a
) -> &'a ReadSignal<U>

Creates a mapped ReadSignal. This is equivalent to using create_memo.

Example

let state = create_signal(cx, 1);
let double = state.map(cx, |&x| x * 2);
assert_eq!(*double.get(), 2);

state.set(2);
assert_eq!(*double.get(), 4);

pub fn track(&self)

When called inside a reactive scope, calling this will add itself to the scope’s dependencies.

To both track and get the value of the signal, use ReadSignal::get instead.

Trait Implementations

impl<T: AddAssign + Copy> AddAssign<T> for &Signal<T>

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<'a, T> AnyReadSignal<'a> for Signal<T>

fn track(&self)

Call the ReadSignal::track method.

impl<T: Debug> Debug for Signal<T>

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

Formats the value using the given formatter.

impl<T> Deref for Signal<T>

type Target = ReadSignal<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Display> Display for Signal<T>

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

Formats the value using the given formatter.

impl<T: DivAssign + Copy> DivAssign<T> for &Signal<T>

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T: Hash> Hash for Signal<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<T: MulAssign + Copy> MulAssign<T> for &Signal<T>

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T: PartialEq> PartialEq<Signal<T>> for Signal<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: SubAssign + Copy> SubAssign<T> for &Signal<T>

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T: Eq> Eq for Signal<T>