Struct ArcMemo

pub struct ArcMemo<T, S = SyncStorage>
where
    S: Storage<T>,
{ /* private fields */ }

An efficient derived reactive value based on other reactive values.

This is a reference-counted memo, which is Clone but not Copy. For arena-allocated Copy memos, use Memo.

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.

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.

Examples

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
// 🆗 run #1: calls `really_expensive_computation` the first time
println!("expensive = {}", expensive());
// ❌ run #2: this calls `really_expensive_computation` a second time!
let some_value = expensive();

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

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.

Implementations

impl<T> ArcMemo<T>

where T: 'static, SyncStorage: Storage<T>,

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

where T: PartialEq,

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

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

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

Creates a new memo by passing a function that computes the value, and a comparison function that takes the previous value and the new value and returns 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.

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

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

Unlike ArcMemo::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<V> AddAnyAttr for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: RenderHtml + Clone + Send + Sync + 'static, <V as Render>::State: 'static,

type Output<SomeNewAttr: Attribute> = ArcMemo<V>

The new type once the attribute has been added.

fn add_any_attr<NewAttr>( self, _attr: NewAttr, ) -> <ArcMemo<V> as AddAnyAttr>::Output<NewAttr>

where NewAttr: Attribute, <ArcMemo<V> as AddAnyAttr>::Output<NewAttr>: RenderHtml,

Adds an attribute to the view.

impl<V> AttributeValue for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: AttributeValue + Clone + Send + Sync + 'static, <V as AttributeValue>::State: 'static,

type AsyncOutput = ArcMemo<V>

The type once all async data have loaded.

type State = RenderEffect<<V as AttributeValue>::State>

The state that should be retained between building and rebuilding.

type Cloneable = ArcMemo<V>

A version of the value that can be cloned. This can be the same type, or a reference-counted type. Generally speaking, this does not need to refer to the same data, but should behave in the same way. So for example, making an event handler cloneable should probably make it reference-counted (so that a FnMut() continues mutating the same closure), but making a String cloneable does not necessarily need to make it an Arc<str>, as two different clones of a String will still have the same value.

type CloneableOwned = ArcMemo<V>

A cloneable type that is also 'static. This is used for spreading across types when the spreadable attribute needs to be owned. In some cases (&'a str to Arc<str>, etc.) the owned cloneable type has worse performance than the cloneable type, so they are separate.

fn html_len(&self) -> usize

An approximation of the actual length of this attribute in HTML.

fn to_html(self, key: &str, buf: &mut String)

Renders the attribute value to HTML.

fn to_template(_key: &str, _buf: &mut String)

Renders the attribute value to HTML for a <template>.

fn hydrate<const FROM_SERVER: bool>( self, key: &str, el: &Element, ) -> <ArcMemo<V> as AttributeValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build(self, el: &Element, key: &str) -> <ArcMemo<V> as AttributeValue>::State

Adds this attribute to the element during client-side rendering.

fn rebuild(self, key: &str, state: &mut <ArcMemo<V> as AttributeValue>::State)

Applies a new value for the attribute.

fn into_cloneable(self) -> <ArcMemo<V> as AttributeValue>::Cloneable

Converts this attribute into an equivalent that can be cloned.

fn into_cloneable_owned(self) -> <ArcMemo<V> as AttributeValue>::CloneableOwned

Converts this attributes into an equivalent that can be cloned and is 'static.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <ArcMemo<V> as AttributeValue>::AsyncOutput

“Resolves” this into a form that is not waiting for any asynchronous data.

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

where S: Storage<T>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where S: Storage<T>,

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

Formats the value using the given formatter.

impl<T, S> DefinedAt for ArcMemo<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> From<ArcMemo<T>> for MaybeSignal<T>

where T: Send + Sync,

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

Converts to this type from the input type.

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<ArcMemo<T>> for Signal<T>

where T: Send + Sync + 'static,

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

Converts to this type from the input type.

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

where T: Send + Sync + 'static,

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

Converts to this type from the input type.

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

where S: Storage<T>,

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

Converts to this type from the input type.

impl<T> From<ArcReadSignal<T>> for ArcMemo<T>

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

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

Converts to this type from the input type.

impl<T> From<ArcRwSignal<T>> for ArcMemo<T>

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

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

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 MaybeSignal<T, LocalStorage>

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

Converts between the types.

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 ArcMemo<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<V> InnerHtmlValue for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: InnerHtmlValue + Send + Sync + Clone + 'static, <V as InnerHtmlValue>::State: 'static,

type AsyncOutput = ArcMemo<V>

The type after all async data have resolved.

type State = RenderEffect<<V as InnerHtmlValue>::State>

The view state retained between building and rebuilding.

type Cloneable = ArcMemo<V>

An equivalent value that can be cloned.

type CloneableOwned = ArcMemo<V>

An equivalent value that can be cloned and is 'static.

fn html_len(&self) -> usize

The estimated length of the HTML.

fn to_html(self, buf: &mut String)

Renders the class to HTML.

fn to_template(_buf: &mut String)

Renders the class to HTML for a <template>.

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ArcMemo<V> as InnerHtmlValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build(self, el: &Element) -> <ArcMemo<V> as InnerHtmlValue>::State

Adds this class to the element during client-side rendering.

fn rebuild(self, state: &mut <ArcMemo<V> as InnerHtmlValue>::State)

Updates the value.

fn into_cloneable(self) -> <ArcMemo<V> as InnerHtmlValue>::Cloneable

Converts this to a cloneable type.

fn into_cloneable_owned(self) -> <ArcMemo<V> as InnerHtmlValue>::CloneableOwned

Converts this to a cloneable, owned type.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <ArcMemo<V> as InnerHtmlValue>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.

impl<C> IntoClass for ArcMemo<C>

where ArcMemo<C>: Get<Value = C>, C: IntoClass + Send + Sync + Clone + 'static, <C as IntoClass>::State: 'static,

type AsyncOutput = ArcMemo<C>

The type after all async data have resolved.

type State = RenderEffect<<C as IntoClass>::State>

The view state retained between building and rebuilding.

type Cloneable = ArcMemo<C>

An equivalent value that can be cloned.

type CloneableOwned = ArcMemo<C>

An equivalent value that can be cloned and is 'static.

fn html_len(&self) -> usize

The estimated length of the HTML.

fn to_html(self, class: &mut String)

Renders the class to HTML.

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ArcMemo<C> as IntoClass>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build(self, el: &Element) -> <ArcMemo<C> as IntoClass>::State

Adds this class to the element during client-side rendering.

fn rebuild(self, state: &mut <ArcMemo<C> as IntoClass>::State)

Updates the value.

fn into_cloneable(self) -> <ArcMemo<C> as IntoClass>::Cloneable

Converts this to a cloneable type.

fn into_cloneable_owned(self) -> <ArcMemo<C> as IntoClass>::CloneableOwned

Converts this to a cloneable, owned type.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <ArcMemo<C> as IntoClass>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.

fn reset(state: &mut <ArcMemo<C> as IntoClass>::State)

Reset the class list to the state before this class was added.

const TEMPLATE: &'static str = ""

The HTML that should be included in a <template>.

const MIN_LENGTH: usize = _

The minimum length of the HTML.

fn to_template(class: &mut String)

Renders the class to HTML for a <template>.

impl<V> IntoProperty for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: IntoProperty + Send + Sync + Clone + 'static, <V as IntoProperty>::State: 'static,

type State = RenderEffect<<V as IntoProperty>::State>

The view state retained between building and rebuilding.

type Cloneable = ArcMemo<V>

An equivalent value that can be cloned.

type CloneableOwned = ArcMemo<V>

An equivalent value that can be cloned and is 'static.

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, key: &str, ) -> <ArcMemo<V> as IntoProperty>::State

Adds the property on an element created from HTML.

fn build(self, el: &Element, key: &str) -> <ArcMemo<V> as IntoProperty>::State

Adds the property during client-side rendering.

fn rebuild(self, state: &mut <ArcMemo<V> as IntoProperty>::State, key: &str)

Updates the property with a new value.

fn into_cloneable(self) -> <ArcMemo<V> as IntoProperty>::Cloneable

Converts this to a cloneable type.

fn into_cloneable_owned(self) -> <ArcMemo<V> as IntoProperty>::CloneableOwned

Converts this to a cloneable, owned type.

impl<C> IntoStyle for ArcMemo<C>

where ArcMemo<C>: Get<Value = C>, C: IntoStyle + Clone + Send + Sync + 'static, <C as IntoStyle>::State: 'static,

type AsyncOutput = ArcMemo<C>

The type after all async data have resolved.

type State = RenderEffect<<C as IntoStyle>::State>

The view state retained between building and rebuilding.

type Cloneable = ArcMemo<C>

An equivalent value that can be cloned.

type CloneableOwned = ArcMemo<C>

An equivalent value that can be cloned and is 'static.

fn to_html(self, style: &mut String)

Renders the style to HTML.

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ArcMemo<C> as IntoStyle>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.

fn build(self, el: &Element) -> <ArcMemo<C> as IntoStyle>::State

Adds this style to the element during client-side rendering.

fn rebuild(self, state: &mut <ArcMemo<C> as IntoStyle>::State)

Updates the value.

fn into_cloneable(self) -> <ArcMemo<C> as IntoStyle>::Cloneable

Converts this to a cloneable type.

fn into_cloneable_owned(self) -> <ArcMemo<C> as IntoStyle>::CloneableOwned

Converts this to a cloneable, owned type.

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <ArcMemo<C> as IntoStyle>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.

fn reset(state: &mut <ArcMemo<C> as IntoStyle>::State)

Reset the styling to the state before this style was added.

impl<T, S> IsDisposed for ArcMemo<T, S>

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

fn is_disposed(&self) -> bool

If true, the signal cannot be accessed without a panic.

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

where S: Storage<T>,

fn eq(&self, other: &ArcMemo<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> ReactiveNode for ArcMemo<T, S>

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

fn mark_dirty(&self)

Notifies the source’s dependencies that it has changed.

fn mark_check(&self)

Notifies the source’s dependencies that it may have changed.

fn mark_subscribers_check(&self)

Marks that all subscribers need to be checked.

fn update_if_necessary(&self) -> bool

Regenerates the value for this node, if needed, and returns whether it has actually changed or not.

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

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

type Value = ReadGuard<T, Mapped<Plain<MemoInner<T, S>>, T>>

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

fn try_read_untracked(&self) -> Option<<ArcMemo<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<V> Render for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: Render + Clone + Send + Sync + 'static, <V as Render>::State: 'static,

type State = RenderEffectState<<V as Render>::State>

The “view state” for this type, which can be retained between updates.

fn build(self) -> <ArcMemo<V> as Render>::State

Creates the view for the first time, without hydrating from existing HTML.

fn rebuild(self, state: &mut <ArcMemo<V> as Render>::State)

Updates the view with new data.

impl<V> RenderHtml for ArcMemo<V>

where ArcMemo<V>: Get<Value = V>, V: RenderHtml + Clone + Send + Sync + 'static, <V as Render>::State: 'static,

const MIN_LENGTH: usize = 0usize

The minimum length of HTML created when this view is rendered.

type AsyncOutput = ArcMemo<V>

The type of the view after waiting for all asynchronous data to load.

fn dry_resolve(&mut self)

“Runs” the view without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.

async fn resolve(self) -> <ArcMemo<V> as RenderHtml>::AsyncOutput

Waits for any asynchronous sections of the view to load and returns the output.

fn html_len(&self) -> usize

An estimated length for this view, when rendered to HTML.

fn to_html_with_buf( self, buf: &mut String, position: &mut Position, escape: bool, mark_branches: bool, )

Renders a view to HTML, writing it into the given buffer.

fn to_html_async_with_buf<const OUT_OF_ORDER: bool>( self, buf: &mut StreamBuilder, position: &mut Position, escape: bool, mark_branches: bool, )

where ArcMemo<V>: Sized,

Renders a view into a buffer of (synchronous or asynchronous) HTML chunks.

fn hydrate<const FROM_SERVER: bool>( self, cursor: &Cursor, position: &PositionState, ) -> <ArcMemo<V> as Render>::State

Makes a set of DOM nodes rendered from HTML interactive.

const EXISTS: bool = true

Whether this should actually exist in the DOM, if it is the child of an element.

fn to_html(self) -> String

where Self: Sized,

Renders a view to an HTML string.

fn to_html_branching(self) -> String

where Self: Sized,

Renders a view to HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_in_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML.

fn to_html_stream_in_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an in-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn to_html_stream_out_of_order(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML.

fn to_html_stream_out_of_order_branching(self) -> StreamBuilder

where Self: Sized,

Renders a view to an out-of-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.

fn hydrate_from<const FROM_SERVER: bool>(self, el: &Element) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element.

fn hydrate_from_position<const FROM_SERVER: bool>( self, el: &Element, position: Position, ) -> Self::State

where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element and position.

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

where T: Serialize + 'static, 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> Source for ArcMemo<T, S>

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

fn add_subscriber(&self, subscriber: AnySubscriber)

Adds a subscriber to this source’s list of dependencies.

fn remove_subscriber(&self, subscriber: &AnySubscriber)

Removes a subscriber from this source’s list of dependencies.

fn clear_subscribers(&self)

Remove all subscribers from this source’s list of dependencies.

impl<T, S> Subscriber for ArcMemo<T, S>

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

fn add_source(&self, source: AnySource)

Adds a subscriber to this subscriber’s list of dependencies.

fn clear_sources(&self, subscriber: &AnySubscriber)

Clears the set of sources for this subscriber.

impl<T, S> ToAnySource for ArcMemo<T, S>

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

fn to_any_source(&self) -> AnySource

Converts this type to its type-erased equivalent.

impl<T, S> ToAnySubscriber for ArcMemo<T, S>

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

fn to_any_subscriber(&self) -> AnySubscriber

Converts this type to its type-erased equivalent.

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

where S: Storage<T>,