Struct LocalResource

pub struct LocalResource<T> { /* private fields */ }

A resource that only loads its data locally on the client.

Implementations

impl<T> LocalResource<T>

pub fn new<Fut>(fetcher: impl Fn() -> Fut + 'static) -> Self

where T: 'static, Fut: Future<Output = T> + 'static,

Creates the resource.

This will only begin loading data if you are on the client (i.e., if you do not have the ssr feature activated).

pub fn refetch(&self)

Re-runs the async function.

pub fn map<U>(&self, f: impl FnOnce(&T) -> U) -> Option<U>

where T: 'static,

Synchronously, reactively reads the current value of the resource and applies the function f to its value if it is Some(_).

impl<T, E> LocalResource<Result<T, E>>

where T: 'static, E: Clone + 'static,

pub fn and_then<U>(&self, f: impl FnOnce(&T) -> U) -> Option<Result<U, E>>

Applies the given function when a resource that returns Result<T, E> has resolved and loaded an Ok(_), rather than requiring nested .map() calls over the Option<Result<_, _>> returned by the resource.

This is useful when used with features like server functions, in conjunction with <ErrorBoundary/> and <Suspense/>, when these other components are left to handle the None and Err(_) states.

Methods from Deref<Target = AsyncDerived<T>>

pub fn ready(&self) -> AsyncDerivedReadyFuture

Returns a Future that is ready when this resource has next finished loading.

pub fn by_ref(&self) -> AsyncDerivedRefFuture<T>

Returns a Future that resolves when the computation is finished, and accesses the inner value by reference rather than by cloning it.

Trait Implementations

impl<T> Clone for LocalResource<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> DefinedAt for LocalResource<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> Deref for LocalResource<T>

type Target = AsyncDerived<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: 'static> From<ArcLocalResource<T>> for LocalResource<T>

fn from(arc: ArcLocalResource<T>) -> Self

Converts to this type from the input type.

impl<T: 'static> From<LocalResource<T>> for ArcLocalResource<T>

fn from(local: LocalResource<T>) -> Self

Converts to this type from the input type.

impl<T> IntoFuture for LocalResource<T>

where T: Clone + 'static,

type Output = T

The output that the future will produce on completion.

type IntoFuture = AsyncDerivedFuture<T>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<T: 'static> IsDisposed for LocalResource<T>

fn is_disposed(&self) -> bool

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

impl<T> Notify for LocalResource<T>

where T: 'static,

fn notify(&self)

Notifies subscribers of a change in this signal.

impl<T> ReactiveNode for LocalResource<T>

where T: 'static,

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> ReadUntracked for LocalResource<T>

where T: 'static,

type Value = ReadGuard<Option<T>, Mapped<AsyncPlain<SendOption<T>>, Option<T>>>

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

fn try_read_untracked(&self) -> Option<Self::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> Source for LocalResource<T>

where T: 'static,

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> Subscriber for LocalResource<T>

where T: 'static,

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> ToAnySource for LocalResource<T>

where T: 'static,

fn to_any_source(&self) -> AnySource

Converts this type to its type-erased equivalent.

impl<T> ToAnySubscriber for LocalResource<T>

where T: 'static,

fn to_any_subscriber(&self) -> AnySubscriber

Converts this type to its type-erased equivalent.

impl<T> Write for LocalResource<T>

where T: 'static,

type Value = Option<T>

The type of the signal’s value.

fn try_write(&self) -> Option<impl UntrackableGuard<Target = Self::Value>>

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

fn try_write_untracked(&self) -> Option<impl DerefMut<Target = Self::Value>>

or None if the signal has already been disposed.

fn write(&self) -> impl UntrackableGuard

Returns the guard.

fn write_untracked(&self) -> impl DerefMut

Returns a guard that will not notify subscribers when dropped.

impl<T> Copy for LocalResource<T>