Struct FilePreferences 

pub struct FilePreferences { /* private fields */ }

File-backed preferences with coordinated, atomic writes within this process.

Instances opening the same canonical path share their values and writer. Reads include pending changes after a failed write; PreferencesStore::flush retries them. A successful write synchronizes the file before replacing it. Concurrent access from other processes is not supported.

Implementations

impl FilePreferences

pub fn new() -> Self

Lazily opens preferences in the application’s config directory.

pub fn at_path(path: impl Into<PathBuf>) -> Self

Lazily opens an explicit preferences file, creating its parent directory.

Trait Implementations

impl Default for FilePreferences

fn default() -> Self

Returns the “default value” for a type.

impl PreferencesStore for FilePreferences

fn get(&self, key: &str) -> Option<String>

Reads key, or None when it has never been written.

fn set(&self, key: &str, value: &str) -> Result<(), PreferencesError>

Writes key.

fn set_many( &self, values: &BTreeMap<String, String>, ) -> Result<(), PreferencesError>

Writes a group of values. File-backed stores replace the file once. A failure may leave pending values visible; retry this batch or call flush.

fn flush(&self) -> Result<(), PreferencesError>

Retries pending writes. Success means the backend accepted all pending data.

fn remove(&self, key: &str) -> Result<(), PreferencesError>

Removes key. Succeeds if it is already absent.

fn keys(&self) -> Vec<String>

Every key currently stored, in sorted order.

fn clear(&self) -> Result<(), PreferencesError>

Removes everything.