Struct ConfigFile 

pub struct ConfigFile { /* private fields */ }

A loaded config file plus the exact source revision it came from.

Saving compares that source with the current file before writing and locks out other cooperating writers through a persistent sidecar. External editors that do not take the lock can still race with a save after its revision check. Existing comments and formatting are retained for keys that still exist.

Implementations

impl ConfigFile

pub fn load_or_default() -> Result<(Config, Self), ConfigError>

Load the default user config, returning a writable default when the file does not exist yet.

pub fn load_from_path(path: &Path) -> Result<(Config, Self), ConfigError>

Load path, retaining its source revision for conflict-safe saves.

pub fn save(&mut self, config: &Config) -> Result<(), ConfigError>

Save config only if the file still matches the loaded revision. Returns a ConfigError::Write with io::ErrorKind::WouldBlock if another writer holds the lock, rather than blocking the caller.

Trait Implementations

impl Clone for ConfigFile

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 ConfigFile

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

Formats the value using the given formatter.