Struct UseStorageOptions

pub struct UseStorageOptions<T, E, D>
where
    T: 'static,
{ /* private fields */ }

Options for use with crate::storage::use_local_storage_with_options, crate::storage::use_session_storage_with_options and use_storage_with_options.

Implementations

impl<T, E, D> UseStorageOptions<T, E, D>

where T: 'static,

pub fn listen_to_storage_changes(self, value: bool) -> Self

pub fn filter(self, value: impl Into<FilterOptions>) -> Self

pub fn delay_during_hydration(self, value: bool) -> Self

Delays the reading of the value from storage by one animation frame during hydration. This ensures that during hydration the value is the initial value just like it is on the server which helps prevent hydration errors. Defaults to false.

impl<T: Default, E, D> UseStorageOptions<T, E, D>

pub fn on_error( self, on_error: impl Fn(UseStorageError<E, D>) + 'static, ) -> Self

Optional callback whenever an error occurs.

pub fn initial_value(self, initial: impl Into<MaybeRwSignal<T>>) -> Self

Initial value to use when the storage key is not set. Note that this value is read once on creation of the storage hook and not updated again. Accepts a signal and defaults to T::default().

Trait Implementations

impl<T: Default, E, D> Default for UseStorageOptions<T, E, D>

fn default() -> Self

Returns the “default value” for a type.