Struct ConfigManager 

pub struct ConfigManager<T> { /* private fields */ }

Implementations

impl<T> ConfigManager<T>

where T: Serialize + DeserializeOwned,

pub fn new() -> Self

Creates a config manager using the OS standard config directory and current executable name.

On Windows desktop apps this resolves under %APPDATA%. Pure UWP apps should use with_root_dir or the optional uwp feature instead.

pub fn at_current_dir(self) -> Self

Stores the settings file in the current working directory.

pub fn with_root_dir<P: Into<PathBuf>>(self, path: P) -> Self

Stores the settings file in a caller-provided directory.

This is the primary compatibility seam for sandboxed hosts, including Pure UWP. The host application may resolve its application data directory and pass it here.

pub fn at_custom_dir<P: Into<PathBuf>>(self, path: P) -> Self

Stores the settings file in a caller-provided directory.

This method is kept for compatibility with v2.0.x. Prefer with_root_dir in new code.

pub fn with_filename(self, name: &str) -> Self

Changes the settings file name.

pub fn disable_pretty_json(self) -> Self

Stores JSON in compact form instead of pretty-printed form.

pub fn folder_path(&self) -> &Path

Returns the settings folder path.

pub fn path(&self) -> PathBuf

Returns the settings file path.

pub fn save(&self, config: &T) -> Result<()>

Saves the complete configuration, replacing the existing file content.

pub fn load(&self) -> Result<T>

Loads a configuration file that is expected to already exist.

impl<T> ConfigManager<T>

where T: Serialize + DeserializeOwned + Default,

pub fn load_or_default(&self) -> Result<T>

Loads the configuration, or creates and saves T::default() on first run.

pub fn update<F>(&self, f: F) -> Result<T>

where F: FnOnce(&mut T),

Applies a read-modify-write update and saves the result.

Trait Implementations

impl<T> Default for ConfigManager<T>

where T: Serialize + DeserializeOwned,

fn default() -> Self

Returns the “default value” for a type.