Struct freya::prelude::Effect

pub struct Effect { /* private fields */ }

Effects allow you to run code when a signal changes. Effects are run immediately and whenever any signal it reads changes.

Implementations

impl Effect

pub fn new(callback: impl FnMut() + 'static) -> Effect

Create a new effect. The effect will be run immediately and whenever any signal it reads changes.

The signal will be owned by the current component and will be dropped when the component is dropped.

pub fn try_run(&mut self)

Run the effect callback immediately. Returns true if the effect was run. Returns false is the effect is dead.

pub fn id(&self) -> GenerationalBoxId

Get the id of this effect.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl PartialEq for Effect

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Effect

impl StructuralPartialEq for Effect