pub struct Loader<T: 'static> { /* private fields */ }Expand description
A Loader is a signal that represents a value that is loaded asynchronously.
Once a Loader<T> has been successfully created from use_loader, it can be use like a normal signal of type T.
When the loader is re-reloading its values, it will no longer suspend its component, making it very useful for server-side-rendering.
Implementations§
Source§impl<T: 'static> Loader<T>
impl<T: 'static> Loader<T>
Sourcepub fn error(&self) -> Option<CapturedError>
pub fn error(&self) -> Option<CapturedError>
Get the error that occurred during loading, if any.
After initial load, this will return None until the next reload fails.
Trait Implementations§
Source§impl<T> IntoAttributeValue for Loader<T>
impl<T> IntoAttributeValue for Loader<T>
Source§fn into_value(self) -> AttributeValue
fn into_value(self) -> AttributeValue
Convert into an attribute value
Source§impl<T> IntoDynNode for Loader<T>
impl<T> IntoDynNode for Loader<T>
Source§fn into_dyn_node(self) -> DynamicNode
fn into_dyn_node(self) -> DynamicNode
Consume this item and produce a DynamicNode
Source§impl<T> Readable for Loader<T>
impl<T> Readable for Loader<T>
Source§fn try_peek_unchecked(&self) -> BorrowResult<ReadableRef<'static, Self>>where
T: 'static,
fn try_peek_unchecked(&self) -> BorrowResult<ReadableRef<'static, Self>>where
T: 'static,
Get the current value of the signal. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.
If the signal has been dropped, this will panic.
Source§type Storage = UnsyncStorage
type Storage = UnsyncStorage
The type of the storage this readable uses.
Source§fn try_read_unchecked(&self) -> Result<ReadableRef<'static, Self>, BorrowError>where
T: 'static,
fn try_read_unchecked(&self) -> Result<ReadableRef<'static, Self>, BorrowError>where
T: 'static,
Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. Read more
Source§fn subscribers(&self) -> Subscriberswhere
T: 'static,
fn subscribers(&self) -> Subscriberswhere
T: 'static,
Get the underlying subscriber list for this readable. This is used to track when the value changes and notify subscribers.
Source§impl<T: 'static> Writable for Loader<T>
impl<T: 'static> Writable for Loader<T>
Source§type WriteMetadata = <Signal<Option<T>> as Writable>::WriteMetadata
type WriteMetadata = <Signal<Option<T>> as Writable>::WriteMetadata
Additional data associated with the write reference.
Source§fn try_write_unchecked(
&self,
) -> Result<WritableRef<'static, Self>, BorrowMutError>where
Self::Target: 'static,
fn try_write_unchecked(
&self,
) -> Result<WritableRef<'static, Self>, BorrowMutError>where
Self::Target: 'static,
Try to get a mutable reference to the value without checking the lifetime. This will update any subscribers. Read more
impl<T> Copy for Loader<T>
Auto Trait Implementations§
impl<T> Freeze for Loader<T>
impl<T> !RefUnwindSafe for Loader<T>
impl<T> !Send for Loader<T>
impl<T> !Sync for Loader<T>
impl<T> Unpin for Loader<T>where
T: Unpin,
impl<T> !UnwindSafe for Loader<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> InitializeFromFunction<T> for T
impl<T> InitializeFromFunction<T> for T
Source§fn initialize_from_function(f: fn() -> T) -> T
fn initialize_from_function(f: fn() -> T) -> T
Create an instance of this type from an initialization function
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<R> ReadableBoxExt for R
impl<R> ReadableBoxExt for R
Source§impl<R> ReadableExt for R
impl<R> ReadableExt for R
Source§fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>where
Self::Target: 'static,
fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>where
Self::Target: 'static,
Get the current value of the state. If this is a signal, this will subscribe the current scope to the signal.
If the value has been dropped, this will panic. Calling this on a Signal is the same as
using the signal() syntax to read and subscribe to its value
Source§fn try_read(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>where
Self::Target: 'static,
fn try_read(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>where
Self::Target: 'static,
Try to get the current value of the state. If this is a signal, this will subscribe the current scope to the signal.
Source§fn read_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>where
Self::Target: 'static,
fn read_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>where
Self::Target: 'static,
Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. Read more
Source§fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>where
Self::Target: 'static,
fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>where
Self::Target: 'static,
Get the current value of the state without subscribing to updates. If the value has been dropped, this will panic. Read more
Source§fn try_peek(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>where
Self::Target: 'static,
fn try_peek(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>where
Self::Target: 'static,
Try to peek the current value of the signal without subscribing to updates. If the value has
been dropped, this will return an error.
Source§fn peek_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>where
Self::Target: 'static,
fn peek_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>where
Self::Target: 'static,
Get the current value of the signal without checking the lifetime. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update. Read more
Source§fn map<F, O>(self, f: F) -> MappedSignal<O, Self, F>
fn map<F, O>(self, f: F) -> MappedSignal<O, Self, F>
Map the references of the readable value to a new type. This lets you provide a view
into the readable value without creating a new signal or cloning the value. Read more
Source§fn cloned(&self) -> Self::Target
fn cloned(&self) -> Self::Target
Clone the inner value and return it. If the value has been dropped, this will panic.
Source§fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> Owhere
Self::Target: 'static,
fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> Owhere
Self::Target: 'static,
Run a function with a reference to the value. If the value has been dropped, this will panic.
Source§impl<T, R> ReadableOptionExt<T> for R
impl<T, R> ReadableOptionExt<T> for R
Source§impl<T, E, R> ReadableResultExt<T, E> for R
impl<T, E, R> ReadableResultExt<T, E> for R
Source§fn unwrap(&self) -> Twhere
T: Clone + 'static,
E: 'static,
fn unwrap(&self) -> Twhere
T: Clone + 'static,
E: 'static,
Unwraps the inner value and clones it.
Source§fn as_ref(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, T>, <Self::Storage as AnyStorage>::Ref<'_, E>>where
T: 'static,
E: 'static,
fn as_ref(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, T>, <Self::Storage as AnyStorage>::Ref<'_, E>>where
T: 'static,
E: 'static,
Attempts to read the inner value of the Option.
Source§impl<T, R> ReadableVecExt<T> for R
impl<T, R> ReadableVecExt<T> for R
Source§fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
Get the first element of the inner vector.
Source§fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
Get the last element of the inner vector.
Source§fn get(&self, index: usize) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
fn get(&self, index: usize) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>where
T: 'static,
Get the element at the given index of the inner vector.
Source§fn iter(&self) -> ReadableValueIterator<'_, Self>where
Self: Sized,
fn iter(&self) -> ReadableValueIterator<'_, Self>where
Self: Sized,
Get an iterator over the values of the inner vector.
Source§impl<Ret> SpawnIfAsync<(), Ret> for Ret
impl<Ret> SpawnIfAsync<(), Ret> for Ret
Source§impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
Source§fn super_from(input: T) -> O
fn super_from(input: T) -> O
Convert from a type to another type.
Source§impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
Source§fn super_into(self) -> O
fn super_into(self) -> O
Convert from a type to another type.
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
Source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Source§impl<T> WritableBoxedExt for Twhere
T: Writable<Storage = UnsyncStorage> + 'static,
impl<T> WritableBoxedExt for Twhere
T: Writable<Storage = UnsyncStorage> + 'static,
Source§impl<W> WritableExt for W
impl<W> WritableExt for W
Source§fn write(
&mut self,
) -> WriteLock<'_, Self::Target, Self::Storage, Self::WriteMetadata>where
Self::Target: 'static,
fn write(
&mut self,
) -> WriteLock<'_, Self::Target, Self::Storage, Self::WriteMetadata>where
Self::Target: 'static,
Get a mutable reference to the value. If the value has been dropped, this will panic.
Source§fn try_write(
&mut self,
) -> Result<WriteLock<'_, Self::Target, Self::Storage, Self::WriteMetadata>, BorrowMutError>where
Self::Target: 'static,
fn try_write(
&mut self,
) -> Result<WriteLock<'_, Self::Target, Self::Storage, Self::WriteMetadata>, BorrowMutError>where
Self::Target: 'static,
Try to get a mutable reference to the value.
Source§fn write_unchecked(
&self,
) -> WriteLock<'static, Self::Target, Self::Storage, Self::WriteMetadata>where
Self::Target: 'static,
fn write_unchecked(
&self,
) -> WriteLock<'static, Self::Target, Self::Storage, Self::WriteMetadata>where
Self::Target: 'static,
Get a mutable reference to the value without checking the lifetime. This will update any subscribers. Read more
Source§fn map_mut<O, F, FMut>(
self,
f: F,
f_mut: FMut,
) -> MappedMutSignal<O, Self, F, FMut>
fn map_mut<O, F, FMut>( self, f: F, f_mut: FMut, ) -> MappedMutSignal<O, Self, F, FMut>
Map the references and mutable references of the writable value to a new type. This lets you provide a view
into the writable value without creating a new signal or cloning the value. Read more
Source§fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> Owhere
Self::Target: 'static,
fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> Owhere
Self::Target: 'static,
Run a function with a mutable reference to the value. If the value has been dropped, this will panic.
Source§fn set(&mut self, value: Self::Target)
fn set(&mut self, value: Self::Target)
Set the value of the signal. This will trigger an update on all subscribers.
Source§fn toggle(&mut self)
fn toggle(&mut self)
Invert the boolean value of the signal. This will trigger an update on all subscribers.
Source§fn index_mut<I>(
&mut self,
index: I,
) -> WriteLock<'_, <Self::Target as Index<I>>::Output, Self::Storage, Self::WriteMetadata>
fn index_mut<I>( &mut self, index: I, ) -> WriteLock<'_, <Self::Target as Index<I>>::Output, Self::Storage, Self::WriteMetadata>
Index into the inner value and return a reference to the result.
Source§impl<T, W> WritableOptionExt<T> for W
impl<T, W> WritableOptionExt<T> for W
Source§fn get_or_insert(
&mut self,
default: T,
) -> WriteLock<'_, T, Self::Storage, Self::WriteMetadata>where
T: 'static,
fn get_or_insert(
&mut self,
default: T,
) -> WriteLock<'_, T, Self::Storage, Self::WriteMetadata>where
T: 'static,
Gets the value out of the Option, or inserts the given value if the Option is empty.
Source§fn get_or_insert_with(
&mut self,
default: impl FnOnce() -> T,
) -> WriteLock<'_, T, Self::Storage, Self::WriteMetadata>where
T: 'static,
fn get_or_insert_with(
&mut self,
default: impl FnOnce() -> T,
) -> WriteLock<'_, T, Self::Storage, Self::WriteMetadata>where
T: 'static,
Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty.
Source§impl<T, W> WritableVecExt<T> for W
impl<T, W> WritableVecExt<T> for W
Source§fn insert(&mut self, index: usize, value: T)where
T: 'static,
fn insert(&mut self, index: usize, value: T)where
T: 'static,
Inserts a new value at the given index.
Source§fn remove(&mut self, index: usize) -> Twhere
T: 'static,
fn remove(&mut self, index: usize) -> Twhere
T: 'static,
Removes the value at the given index.
Source§fn extend(&mut self, iter: impl IntoIterator<Item = T>)where
T: 'static,
fn extend(&mut self, iter: impl IntoIterator<Item = T>)where
T: 'static,
Extends the vector with the given iterator.
Source§fn swap_remove(&mut self, index: usize) -> Twhere
T: 'static,
fn swap_remove(&mut self, index: usize) -> Twhere
T: 'static,
Swaps two values in the vector.
Source§fn retain(&mut self, f: impl FnMut(&T) -> bool)where
T: 'static,
fn retain(&mut self, f: impl FnMut(&T) -> bool)where
T: 'static,
Retains only the values that match the given predicate.
Source§fn split_off(&mut self, at: usize) -> Vec<T>where
T: 'static,
fn split_off(&mut self, at: usize) -> Vec<T>where
T: 'static,
Splits the vector into two at the given index.