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) -> LocalResource<T>

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.

Trait Implementations

impl<T> Clone for LocalResource<T>

fn clone(&self) -> LocalResource<T>

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> From<ArcLocalResource<T>> for LocalResource<T>

where T: 'static,

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

Converts to this type from the input type.

impl<T> From<LocalResource<T>> for ArcLocalResource<T>

where T: 'static,

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

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 = Map<AsyncDerivedFuture<SendWrapper<T>>, fn(SendWrapper<T>) -> T>

Which kind of future are we turning this into?

fn into_future(self) -> <LocalResource<T> as IntoFuture>::IntoFuture

Creates a future from a value.

impl<T> IsDisposed for LocalResource<T>

where T: 'static,

fn is_disposed(&self) -> bool

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

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<SendWrapper<T>>, AsyncPlain<Option<SendWrapper<T>>>>

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

fn try_read_untracked( &self, ) -> Option<<LocalResource<T> 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> 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> Copy for LocalResource<T>