Struct sycamore_reactive::Signal
source · [−]pub struct Signal<T>(_);
Expand description
Reactive state that can be updated and subscribed to.
Implementations
sourceimpl<T> Signal<T>
impl<T> Signal<T>
sourcepub fn set(&self, value: 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 = ctx.create_signal(0);
assert_eq!(*state.get(), 0);
state.set(1);
assert_eq!(*state.get(), 1);
sourcepub fn set_silent(&self, value: T)
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.
sourceimpl<T: Default> Signal<T>
impl<T: Default> Signal<T>
sourcepub fn take(&self) -> Rc<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.
sourcepub fn take_silent(&self) -> Rc<T>
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>>
sourcepub fn get(&self) -> Rc<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 = ctx.create_signal(0);
assert_eq!(*state.get(), 0);
state.set(1);
assert_eq!(*state.get(), 1);
sourcepub fn get_untracked(&self) -> Rc<T>
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 = ctx.create_signal(1);
let double = ctx.create_memo(|| *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);
sourcepub fn map<'a, U>(
&'a self,
ctx: ScopeRef<'a>,
f: impl FnMut(&T) -> U + 'a
) -> &'a ReadSignal<U>
pub fn map<'a, U>(
&'a self,
ctx: ScopeRef<'a>,
f: impl FnMut(&T) -> U + 'a
) -> &'a ReadSignal<U>
Creates a mapped ReadSignal
. This is equivalent to using
create_memo
.
Example
let state = ctx.create_signal(1);
let double = state.map(&ctx, |&x| x * 2);
assert_eq!(*double.get(), 2);
state.set(2);
assert_eq!(*double.get(), 4);
sourcepub fn track(&self)
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
sourceimpl<'a, T> AnyReadSignal<'a> for Signal<T>
impl<'a, T> AnyReadSignal<'a> for Signal<T>
sourcefn track(&self)
fn track(&self)
Call the ReadSignal::track
method.
sourceimpl<'a, T> Deref for Signal<T>
impl<'a, T> Deref for Signal<T>
type Target = ReadSignal<T>
type Target = ReadSignal<T>
The resulting type after dereferencing.
impl<T: Eq> Eq for Signal<T>
Auto Trait Implementations
impl<T> !RefUnwindSafe for Signal<T>
impl<T> !Send for Signal<T>
impl<T> !Sync for Signal<T>
impl<T> Unpin for Signal<T>
impl<T> !UnwindSafe for Signal<T>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.