Struct leptos_use::storage::UseStorageOptions

pub struct UseStorageOptions<T: 'static, C: StringCodec<T>> { /* private fields */ }

Options for use with [use_local_storage_with_options], [use_session_storage_with_options] and use_storage_with_options.

Implementations

impl<T: Default, C: StringCodec<T>> UseStorageOptions<T, C>

pub fn codec(self, codec: impl Into<C>) -> Self

Sets the codec to use for encoding and decoding values to and from UTF-16 strings.

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

Optional callback whenever an error occurs.

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

Listen to changes to this storage key from browser and page events. Defaults to true.

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().

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

Debounce or throttle the writing to storage whenever the value changes.

Trait Implementations

impl<T: Default, C: StringCodec<T> + Default> Default for UseStorageOptions<T, C>

fn default() -> Self

Returns the “default value” for a type.