Struct Signal 

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

A reactive value.

A signal either holds a plain value (set) or is derived from other signals (bind). Derived signals are lazy: writes only mark dependents dirty, and the closure re-runs on the next get. Cloning a Signal clones the handle, not the value.

Implementations

impl<T> Signal<T>

where T: Clone + 'static,

pub fn new(value: T) -> Signal<T>

A signal holding value.

pub fn derived(f: impl Fn() -> T + 'static) -> Signal<T>

where T: Default,

A derived signal. The closure runs lazily on the first get.

pub fn with_name(self, name: impl Into<Rc<str>>) -> Signal<T>

Name used in diagnostics (cycle panics, inspector).

pub fn name(&self) -> Option<Rc<str>>

Name shown in the editor’s inspector, if any.

pub fn get(&self) -> T

Current value; a bound signal recomputes only if its inputs changed.

Panics

In debug builds, if bound signals depend on each other in a cycle (release builds return the last value instead).

pub fn peek(&self) -> T

Reads without registering a dependency.

pub fn set(&self, value: T)

Sets a plain value; removes any binding.

pub fn bind(&self, f: impl Fn() -> T + 'static)

Makes this signal derived from f.

pub fn is_bound(&self) -> bool

Whether the value comes from bind.

pub fn to(&self, target: impl Into<T>, duration: impl Seconds) -> Tween<T>

where T: Lerp,

Tweens from the current value to target over duration seconds.

f64 is seconds. A theme pace (Normal) is a duration too.

Trait Implementations

impl<T> Clone for Signal<T>

fn clone(&self) -> Signal<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Signal<T>

where T: Debug,

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

Formats the value using the given formatter.