Struct Signal 

pub struct Signal<T: 'static> { /* private fields */ }

A value that the reactive closures reading it follow. Copy: a move closure takes it without a clone.

Implementations

impl<T: 'static> Signal<T>

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Calls f with the value, and records the read when a memo or an effect is running.

pub fn with_untracked<R>(&self, f: impl FnOnce(&T) -> R) -> R

Calls f with the value without recording the read.

pub fn get(&self) -> T

where T: Clone,

A copy of the value; the read is recorded.

pub fn get_untracked(&self) -> T

where T: Clone,

A copy of the value; the read is not recorded.

pub fn set(&self, value: T)

Replaces the value, and runs what reads it.

pub fn set_if_changed(&self, value: T)

where T: PartialEq,

Replaces the value when it differs from the one held; a value that is equal changes nothing and runs nothing.

pub fn update(&self, f: impl FnOnce(&mut T))

Changes the value in place, and runs what reads it.

pub fn take(&self) -> T

where T: Default,

Takes the value, leaving the default, and runs what reads it.

pub fn two_way(self) -> TwoWay<T>

The signal as a two-way value of a property: the property follows the signal, and a change of the property (the user typed, moved a slider) is written into the signal.

pub fn is_alive(&self) -> bool

Whether the owner of the signal is still alive.

Trait Implementations

impl<T: 'static> Clone for Signal<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: 'static> Copy for Signal<T>

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

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

Formats the value using the given formatter.

impl<T: PropertyValue, V: IntoValue<T> + Clone + 'static> IntoProp<T, FromSignal<V>> for Signal<V>

fn into_prop(self) -> PropValue

The value of the element.

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

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

Equality operator ==.

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

Inequality operator !=.