Skip to main content

LazyComponent

Struct LazyComponent 

Source
pub struct LazyComponent<T: Clone + PartialEq + 'static> { /* private fields */ }
Expand description

A lazy component that defers factory invocation until first access.

Use LazyComponent::new(factory) to construct, then get() to read (which triggers the factory on first call) or prefetch() to trigger without reading.

§Why use Rc<dyn Fn() -> T>?

Because the factory must be callable multiple times (e.g. after a reset()), and dyn Fn lets the user pass any closure that produces a T. The factory is stored as Rc<dyn Fn() -> T> (not Box<dyn Fn>) so LazyComponent can be cloned cheaply and shared between hook contexts.

Implementations§

Source§

impl<T: Clone + PartialEq + 'static> LazyComponent<T>

Source

pub fn new<F>(factory: F) -> Self
where F: Fn() -> T + 'static,

Creates a new lazy component with the given factory. The factory is NOT called yet.

§Arguments
  • F: Fn() -> T + 'static - A generic type parameter.
Source

pub fn prefetch(&self)

Triggers the factory without reading the value. Idempotent: calling prefetch() twice does not run the factory twice.

Source

pub fn get(&self) -> Option<T>

Reads the value, calling the factory on the first call. Subsequent calls return the cached value.

§Returns
  • Option<T> - The current value (or a snapshot thereof).
Source

pub fn loaded(&self) -> Option<T>

Returns the loaded value, or None if the state is Pending, Loading, or Failed.

Use Self::get (which runs the factory if needed) when you want the value-or-None semantics. This method is for the rare case where you already know the value was loaded and you want to inspect it without triggering a synchronous factory call.

§Returns
  • Option<T> - Some(value) when an asynchronously-loaded value is available, otherwise None.
Source

pub fn reset(&self)

Resets the lazy component to Pending. The next get() call will re-run the factory.

Source

pub fn change_factory<F>(&self, factory: F)
where F: Fn() -> T + 'static,

Replaces the factory. The state is reset to Pending so the next get() runs the new factory.

§Arguments
  • F: Fn() -> T + 'static - A generic type parameter.
Source§

impl<T: Clone + PartialEq + 'static> LazyComponent<T>

Source

pub fn get_state(&self) -> &Signal<LoadState<T>>

Source

pub fn get_mut_state(&mut self) -> &mut Signal<LoadState<T>>

Source

pub fn set_state(&mut self, val: Signal<LoadState<T>>) -> &mut Self

Source

pub fn get_factory(&self) -> &Rc<dyn Fn() -> T>

Source

pub fn get_mut_factory(&mut self) -> &mut Rc<dyn Fn() -> T>

Source

pub fn set_factory(&mut self, val: Rc<dyn Fn() -> T>) -> &mut Self

Trait Implementations§

Source§

impl<T: Clone + Clone + PartialEq + 'static> Clone for LazyComponent<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Clone + PartialEq + Debug + 'static> Debug for LazyComponent<T>

Source§

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

Formats the LazyComponent via the supplied formatter.

§Arguments
  • &mut Formatter<'_> - The formatter receiving the formatted output.
§Returns
  • FmtResult - Result of the formatting operation.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for LazyComponent<T>

§

impl<T> !Send for LazyComponent<T>

§

impl<T> !Sync for LazyComponent<T>

§

impl<T> !UnwindSafe for LazyComponent<T>

§

impl<T> Freeze for LazyComponent<T>
where Signal<LoadState<T>>: Freeze, Rc<dyn Fn() -> T>: Freeze,

§

impl<T> Unpin for LazyComponent<T>
where Signal<LoadState<T>>: Unpin, Rc<dyn Fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for LazyComponent<T>
where Signal<LoadState<T>>: UnsafeUnpin, Rc<dyn Fn() -> T>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more