Struct SettingsStore 

pub struct SettingsStore { /* private fields */ }

A dynamic dotted-key reactive settings store.

Clone is cheap (an Rc bump). All clones share one cache and one I/O thread.

Implementations

impl SettingsStore

pub fn open(path: PathBuf) -> Result<Self, SettingsStoreError>

Open a store at path with the default debounce window.

pub fn open_with_delay( path: PathBuf, delay: Duration, ) -> Result<Self, SettingsStoreError>

Open a store at path with a custom debounce window. delay = Duration::ZERO is useful for tests — every set writes through on the next worker iteration, and flush_now() is fully deterministic.

pub fn path(&self) -> &Path

Path of the underlying file.

pub fn flush_now(&self) -> Result<(), SettingsStoreError>

Force any pending payload to disk synchronously.

pub fn has(&self, key: &str) -> bool

Whether the given key has already been registered.

pub fn registered_keys(&self) -> Vec<String>

All keys registered so far. Order is unspecified.

pub fn signal<T>(&self, key: &str, default: T) -> Signal<T>

where T: Clone + Serialize + DeserializeOwned + 'static,

Get-or-create a Signal<T> for key, seeded from disk or default if absent. Subsequent calls for the same key return clones of the same signal.

Panics

• If the key was previously registered with a different type.
• If the key’s path conflicts with an existing leaf-value / table shape (e.g. "editor" is a string and now you ask for "editor.font_size").

pub fn signal_for<T>(&self, key: &SettingsKey<T>) -> Signal<T>

where T: Clone + Serialize + DeserializeOwned + 'static,

Like signal, but driven by a strongly-named SettingsKey<T> constant.

impl SettingsStore

pub fn open_path(path: &Path) -> Result<Self, SettingsStoreError>

Convenience constructor accepting &Path.

Trait Implementations

impl Clone for SettingsStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsStore

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

Formats the value using the given formatter.

impl Reloadable for SettingsStore

fn path(&self) -> &Path

The file this instance reads from and writes to. A watcher uses this to know which path to associate with which Reloadable handle.

fn reload_from_disk(&self) -> Result<bool, SettingsFileError>

Re-read the file from disk and push any genuinely new content into live signals/models.