Struct SettingsBundle 

pub struct SettingsBundle { /* private fields */ }

Declarative configuration for the persistence services an app wants installed.

use teksilo_settings::SettingsBundle;
use std::time::Duration;

let bundle = SettingsBundle::new()
    .with_window_state(true)
    .with_debounce(Duration::from_millis(250));

Implementations

impl SettingsBundle

pub fn new() -> Self

Default bundle: opens the K/V store under general.toml, no window-state persistence.

pub fn with_store_name(self, name: impl Into<String>) -> Self

Override the K/V store filename (without .toml). Default: general.

pub fn with_window_state(self, enabled: bool) -> Self

Enable the window-state service. The service stores per-label entries, so a multi-window app records each window’s geometry under its own label (e.g. "main", "log", "inspector").

pub fn with_debounce(self, delay: Duration) -> Self

Override the debounce window passed to every service this bundle opens.

Both SettingsStore and WindowStateService actually debounce on it: SettingsStore’s writes are frequent enough (every Signal::set) that coalescing matters, and WindowStateService’s record fires once per reported window-geometry frame during a drag, so it schedules its own coalesced write through the same delay via a DebouncedWriter (see window_state.rs’s module docs, “record is debounced, not synchronous”). It is a plain crate::SettingsFile — not opened by this bundle — whose writes are always a synchronous locked read-modify-write, with nothing left to debounce (see file.rs’s module docs).

pub fn store_name(&self) -> &str

The filename stem (without .toml) used for the K/V store.

pub fn debounce(&self) -> Duration

The debounce window passed to every service this bundle opens (see with_debounce for which services actually honor it).

pub fn open( self, paths: &AppPaths, ) -> Result<OpenedSettings, SettingsBundleError>

Open every requested service against paths.

Every opened service is also registered into a fresh SettingsRegistry (exposed as OpenedSettings::registry) under its canonical path, so a crate::SettingsWatcher event naming that path can be dispatched straight to it. The registration handles are retained internally by OpenedSettings — see its field docs — so they stay alive (and thus dispatchable) for as long as the returned OpenedSettings (or any clone of it) is.

Trait Implementations

impl Clone for SettingsBundle

fn clone(&self) -> SettingsBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsBundle

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

Formats the value using the given formatter.

impl Default for SettingsBundle

fn default() -> Self

Returns the “default value” for a type.