Skip to main content

Signal

Struct Signal 

Source
pub struct Signal<T: 'static>(/* private fields */);

Implementations§

Source§

impl<T> Signal<T>

Source

pub fn new(value: T) -> Self

Source

pub fn id(&self) -> usize

Source

pub fn get(&self) -> T
where T: Clone,

Source

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

Read the current value without cloning it, tracking the read in the reactive graph. Prefer over get for large/expensive-to-clone types.

Source

pub fn set_neq(&self, v: T)
where T: PartialEq + Clone,

Set the signal value only if it changed, skipping subscribers, the reactive graph, and the frame request when the value is unchanged.

Source

pub fn set(&self, v: T)
where T: Clone,

Set the signal value and notify subscribers + the reactive graph. Always notifies, even if the value is equal - prefer set_neq for UI state where equality is cheap. Subscribers observe a snapshot clone, so re-entrant set/update inside a subscriber cannot alias the reference they hold.

Source

pub fn update<F: FnOnce(&mut T)>(&self, f: F)
where T: Clone,

Source

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

Source

pub fn unsubscribe(&self, id: SubId) -> bool

Remove a subscriber by id. Returns true if removed.

Source

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

Subscribe and get a guard that auto-unsubscribes on drop.

Trait Implementations§

Source§

impl<T> Clone for Signal<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Signal<T>

§

impl<T> !Send for Signal<T>

§

impl<T> !Sync for Signal<T>

§

impl<T> !UnwindSafe for Signal<T>

§

impl<T> Freeze for Signal<T>
where Rc<RefCell<Inner<T>>>: Freeze,

§

impl<T> Unpin for Signal<T>
where Rc<RefCell<Inner<T>>>: Unpin,

§

impl<T> UnsafeUnpin for Signal<T>
where Rc<RefCell<Inner<T>>>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.