Struct Memo

pub struct Memo<T, S = SyncStorage>
where
    S: Storage<T>,
{
    inner: ArenaItem<ArcMemo<T, S>, S>,
}

A memo is an efficient derived reactive value based on other reactive values.

Unlike a “derived signal,” a memo comes with two guarantees:

1. The memo will only run once per change, no matter how many times you access its value.
2. The memo will only notify its dependents if the value of the computation changes.

This makes a memo the perfect tool for expensive computations.

Memos have a certain overhead compared to derived signals. In most cases, you should create a derived signal. But if the derivation calculation is expensive, you should create a memo.

Memos are lazy: they do not run at all until they are read for the first time, and they will not re-run the calculation when a source signal changes until they are read again.

This is an arena-allocated type, which is Copy and is disposed when its reactive Owner cleans up. For a reference-counted signal that lives as as long as a reference to it is alive, see ArcMemo.

let (value, set_value) = signal(0);

// 🆗 we could create a derived signal with a simple function
let double_value = move || value.get() * 2;
set_value.set(2);
assert_eq!(double_value(), 4);

// but imagine the computation is really expensive
let expensive = move || really_expensive_computation(value.get()); // lazy: doesn't run until called
Effect::new(move |_| {
  // 🆗 run #1: calls `really_expensive_computation` the first time
  println!("expensive = {}", expensive());
});
Effect::new(move |_| {
  // ❌ run #2: this calls `really_expensive_computation` a second time!
  let value = expensive();
  // do something else...
});

// instead, we create a memo
// 🆗 run #1: the calculation runs once immediately
let memoized = Memo::new(move |_| really_expensive_computation(value.get()));
Effect::new(move |_| {
  // 🆗 reads the current value of the memo
  //    can be `memoized()` on nightly
  println!("memoized = {}", memoized.get());
});
Effect::new(move |_| {
  // ✅ reads the current value **without re-running the calculation**
  let value = memoized.get();
  // do something else...
});

Core Trait Implementations

• .get() clones the current value of the memo. If you call it within an effect, it will cause that effect to subscribe to the memo, and to re-run whenever the value of the memo changes.
  • .get_untracked() clones the value of the memo without reactively tracking it.
• .read() returns a guard that allows accessing the value of the memo by reference. If you call it within an effect, it will cause that effect to subscribe to the memo, and to re-run whenever the value of the memo changes.
  • .read_untracked() gives access to the current value of the memo without reactively tracking it.
• .with() allows you to reactively access the memo’s value without cloning by applying a callback function.
  • .with_untracked() allows you to access the memo’s value by applying a callback function without reactively tracking it.
• .to_stream() converts the memo to an async stream of values.
• ::from_stream() converts an async stream of values into a memo containing the latest value.

Fields

inner: ArenaItem<ArcMemo<T, S>, S>

Implementations

impl<T> Memo<T>

where T: Send + Sync + 'static,

pub fn new(fun: impl Fn(Option<&T>) -> T + Send + Sync + 'static) -> Memo<T>

where T: PartialEq,

Creates a new memoized, computed reactive value.

As with an Effect, the argument to the memo function is the previous value, i.e., the current value of the memo, which will be None for the initial calculation.

let (value, set_value) = signal(0);

// the memo will reactively update whenever `value` changes
let memoized =
    Memo::new(move |_| really_expensive_computation(value.get()));

pub fn new_with_compare( fun: impl Fn(Option<&T>) -> T + Send + Sync + 'static, changed: fn(Option<&T>, Option<&T>) -> bool, ) -> Memo<T>

Creates a new memo with a custom comparison function. By default, memos simply use PartialEq to compare the previous value to the new value. Passing a custom comparator allows you to compare the old and new values using any criteria.

changed should be a function that returns true if the new value is different from the old value.

pub fn new_owning( fun: impl Fn(Option<T>) -> (T, bool) + Send + Sync + 'static, ) -> Memo<T>

Creates a new memo by passing a function that computes the value.

Unlike Memo::new, this receives ownership of the previous value. As a result, it must return both the new value and a bool that is true if the value has changed.

This is lazy: the function will not be called until the memo’s value is read for the first time.

Trait Implementations

impl<T, S> Clone for Memo<T, S>

where S: Storage<T>,

fn clone(&self) -> Memo<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for Memo<T, S>

where S: Debug + Storage<T>,

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

Formats the value using the given formatter.

impl<T, S> DefinedAt for Memo<T, S>

where S: Storage<T>,

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.

impl<T, S> Dispose for Memo<T, S>

where S: Storage<T>,

fn dispose(self)

Disposes of the signal. This:

impl<T, S> Fn() for Memo<T, S>

where Memo<T, S>: Get, S: Storage<T> + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

extern "rust-call" fn call( &self, _args: (), ) -> <Memo<T, S> as FnOnce()>::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T, S> FnMut() for Memo<T, S>

where Memo<T, S>: Get, S: Storage<T> + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

extern "rust-call" fn call_mut( &mut self, _args: (), ) -> <Memo<T, S> as FnOnce()>::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T, S> FnOnce() for Memo<T, S>

where Memo<T, S>: Get, S: Storage<T> + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

type Output = <Memo<T, S> as Get>::Value

The returned type after the call operator is used.

extern "rust-call" fn call_once( self, _args: (), ) -> <Memo<T, S> as FnOnce()>::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl<T> From<ArcMemo<T>> for Memo<T>

where T: Send + Sync + 'static,

fn from(value: ArcMemo<T>) -> Memo<T>

Converts to this type from the input type.

impl<T> From<ArcReadSignal<T>> for Memo<T>

where T: Clone + PartialEq + Send + Sync + 'static,

fn from(value: ArcReadSignal<T>) -> Memo<T>

Converts to this type from the input type.

impl<T> From<Memo<Option<T>>> for MaybeProp<T>

where T: Send + Sync,

fn from(value: Memo<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.

impl<T> From<Memo<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>

where T: Send + Sync,

fn from(value: Memo<Option<T>, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.

impl<T> From<Memo<T>> for MaybeProp<T>

where T: Send + Sync + Clone,

fn from(value: Memo<T>) -> MaybeProp<T>

Converts to this type from the input type.

impl<T> From<Memo<T>> for MaybeSignal<T>

where T: Send + Sync,

fn from(value: Memo<T>) -> MaybeSignal<T>

Converts to this type from the input type.

impl<T> From<Memo<T>> for OptionalProp<Signal<T>>

where T: Send + Sync + 'static,

fn from(value: Memo<T>) -> OptionalProp<Signal<T>>

Converts to this type from the input type.

impl<T> From<Memo<T>> for Signal<T>

where T: Send + Sync + 'static,

fn from(value: Memo<T>) -> Signal<T>

Converts to this type from the input type.

impl<T> From<Memo<T, LocalStorage>> for MaybeProp<T, LocalStorage>

where T: Send + Sync + Clone,

fn from(value: Memo<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.

impl<T> From<Memo<T, LocalStorage>> for MaybeSignal<T, LocalStorage>

fn from(value: Memo<T, LocalStorage>) -> MaybeSignal<T, LocalStorage>

Converts to this type from the input type.

impl<T> From<Memo<T, LocalStorage>> for Signal<T, LocalStorage>

where T: 'static,

fn from(value: Memo<T, LocalStorage>) -> Signal<T, LocalStorage>

Converts to this type from the input type.

impl<T, S> From<Memo<T, S>> for ArcMemo<T, S>

where T: 'static, S: Storage<ArcMemo<T, S>> + Storage<T>,

fn from(value: Memo<T, S>) -> ArcMemo<T, S>

Converts to this type from the input type.

impl<T> FromLocal<ArcMemo<T, LocalStorage>> for Memo<T, LocalStorage>

where T: 'static,

fn from_local(value: ArcMemo<T, LocalStorage>) -> Memo<T, LocalStorage>

Converts between the types.

impl<T, S> Hash for Memo<T, S>

where S: Storage<T>,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, S> PartialEq for Memo<T, S>

where S: Storage<T>,

fn eq(&self, other: &Memo<T, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, S> ReadUntracked for Memo<T, S>

where T: 'static, S: Storage<ArcMemo<T, S>> + Storage<T>,

type Value = ReadGuard<T, Mapped<Plain<Option<<S as Storage<T>>::Wrapped>>, T>>

The guard type that will be returned, which can be dereferenced to the value.

fn try_read_untracked(&self) -> Option<<Memo<T, S> as ReadUntracked>::Value>

Returns the guard, or None if the signal has already been disposed.

fn read_untracked(&self) -> Self::Value

Returns the guard.

fn custom_try_read(&self) -> Option<Option<Self::Value>>

This is a backdoor to allow overriding the Read::try_read implementation despite it being auto implemented.

impl<T, St> Serialize for Memo<T, St>

where T: Serialize + 'static, St: Storage<ArcMemo<T, St>> + Storage<T>,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, S> Track for Memo<T, S>

where T: 'static, S: Storage<ArcMemo<T, S>> + Storage<T>, ArcMemo<T, S>: Track,

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.

impl<T, S> Copy for Memo<T, S>

where S: Storage<T>,

impl<T, S> Eq for Memo<T, S>

where S: Storage<T>,