Struct Effect 

pub struct Effect(/* private fields */);

A reactive effect that re-runs when its dependencies change.

Effects are eager: when a dependency signal changes, the effect closure is re-run immediately. The effect also runs once on creation to discover its initial dependencies.

Examples

let count = Signal::new(0);
let log = Rc::new(RefCell::new(Vec::new()));

let effect = Effect::new({
    let count = count.clone();
    let log = log.clone();
    move || {
        log.borrow_mut().push(count.get());
    }
});

count.set(1); // effect re-runs, logs [0, 1]

Implementations

impl Effect

pub fn new(f: impl FnMut() + 'static) -> Self

Create a new effect that runs the given closure.

The closure is called immediately to discover dependencies. It will be re-called whenever any signal read during its execution changes.

pub fn is_active(&self) -> bool

Check if this effect is still active.

pub fn dispose(&self)

Permanently deactivate this effect.

Once disposed, the effect will not run again even if its dependencies change.

pub fn subscriber_id(&self) -> SubscriberId

Get this effect’s subscriber ID.

pub fn as_subscriber(&self) -> Weak<dyn Subscriber>

Get a weak reference suitable for subscribing to signals.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.