Struct Signal

pub struct Signal<T: ?Sized>(/* private fields */);

A Signal that can be written to.

This is a wrapper around ReadSignal.

Signals are used to store state that can be read from and written to. Using ReadSignal::get() and Signal::set(). Getting the value of a signal will track the signal in the currently running effect, and setting the value of a signal will trigger all the callbacks and effects, that are subscribed to the signal.

Example

// create a new signal
let signal = cx.signal(0);

// create a new effect
cx.effect(|| {
    // this will be called when it's created
    // and every time the signal is set
    println!("signal value: {}", signal.get());
});

// set the signal to 1
// this will trigger the effect
signal.set(1);

Implementations

impl<T> Signal<T>

pub fn new(value: T) -> Self

Creates a new Signal from a value.

pub fn set(&self, value: T)

Sets the value of self.

pub fn set_silent(&self, value: T)

Sets the value of self without triggering the callbacks.

impl<T: ?Sized> Signal<T>

pub fn new_arc(value: Rc<T>) -> Self

Creates a new Signal from an [Shared].

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

Sets the value of self to an [Shared].

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

Sets the value of self to an [Shared] without triggering the callbacks.

pub fn emit(&self)

Emits the CallbackEmitter for this Signal.

impl<T: Clone> Signal<T>

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

Returns a Modify that can be used to modify the value of the Signal. When the Modify is dropped, the Signal will be updated.

Methods from Deref<Target = ReadSignal<T>>

pub fn emitter(&self) -> &CallbackEmitter

Gets the CallbackEmitter for this ReadSignal.

pub fn track(&self)

Tracks self in the currently running effect.

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

Gets the current value of self.

This will track self in the currently running effect.

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

Gets the current value of self without tracking it.

pub fn cloned(&self) -> T

Returns a clone of the current value of self.

This will track self in the currently running effect.

pub fn cloned_untracked(&self) -> T

Returns a clone of the current value of self without tracking it.

pub fn copied(&self) -> T

Returns a copy to the current value of self.

pub fn copied_untracked(&self) -> T

Returns a copy to the current value of self.

Trait Implementations

impl<'a, T: Clone + PartialEq + SendSync + 'static> Bindable<'a> for &'a Signal<T>

type Item = T

fn bind(&mut self, cx: Scope<'a>, signal: &'a Signal<Self::Item>)

impl<T: Debug + ?Sized> Debug for Signal<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Signal<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Deref for Signal<T>

type Target = ReadSignal<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Hash + ?Sized> 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + ?Sized> Ord for Signal<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized> PartialEq<T> for Signal<T>

fn eq(&self, other: &T) -> 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: PartialEq + ?Sized> PartialEq for Signal<T>

fn eq(&self, other: &Self) -> 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: PartialOrd + ?Sized> PartialOrd<T> for Signal<T>

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialOrd + ?Sized> PartialOrd for Signal<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + ?Sized> Eq for Signal<T>