Struct ReadSignal

Source
pub struct ReadSignal<T>(/* private fields */);
Expand description

Receive changes from a signal.

Changes will stop being received when this is destroyed:

let x = Signal::new(1);
let seen_by_y = Rc::new(Cell::new(0));
let y = x.read().map({
    clone!(seen_by_y);
    move|&x| seen_by_y.set(x)
});
assert_eq!(seen_by_y.get(), 1);
x.write().set(2);
assert_eq!(seen_by_y.get(), 2);
mem::drop(y);
// We won't see this update
x.write().set(3);
assert_eq!(seen_by_y.get(), 2);

Implementations§

Source§

impl<T: 'static> ReadSignal<T>

Source

pub fn current(&self) -> Ref<'_, T>

The current value of the signal

Source

pub fn only_changes(&self) -> ReadSignal<T>
where T: Clone + Eq,

Only propagate actual changes to the signal value.

let all_updates_count = Rc::new(Cell::new(0));
let only_changes_count = Rc::new(Cell::new(0));
let x = Signal::new(0);
let all_updates = x.read().map({
    clone!(all_updates_count);
    move |_| all_updates_count.set(all_updates_count.get() + 1)
});
let only_changes = x.read().only_changes().map({
    clone!(only_changes_count);
    move |_| only_changes_count.set(only_changes_count.get() + 1)
});

x.write().set(1);
x.write().set(1);
assert_eq!(all_updates_count.get(), 3, "One for init + 2 updates");
assert_eq!(only_changes_count.get(), 2, "One for init + 1 actual change");
Source

pub fn map<Output, Generate>(&self, generate: Generate) -> ReadSignal<Output>
where Output: 'static, Generate: 'static + Fn(&T) -> Output,

Map a function onto the inner value to produce a new ReadSignal.

This only exists to make type inference easier, and just forwards its arguments to map_to.

Source

pub fn map_to<Output>( &self, receiver: impl SignalReceiver<T, Output>, ) -> ReadSignal<Output>
where Output: 'static,

Receive changes to a signal.

Trait Implementations§

Source§

impl<T> Clone for ReadSignal<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ReadSignal<T>

§

impl<T> !RefUnwindSafe for ReadSignal<T>

§

impl<T> !Send for ReadSignal<T>

§

impl<T> !Sync for ReadSignal<T>

§

impl<T> Unpin for ReadSignal<T>

§

impl<T> !UnwindSafe for ReadSignal<T>

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.