Struct Config

pub struct Config<TConfigData: Serialize + DeserializeOwned + Default> { /* private fields */ }

Generic struct for managing an app’s chunk of config data on disk.

Saves config files in $ILO_CONFIG_HOME, or ~/.config/ilo/ if the former is not set.

About the DeserializeOwned trait bound: see https://serde.rs/lifetimes.html. Since the struct itself is loading the data from a file, it’s in command of its own deserializer lifetimes.

Implementations

impl<TConfigData: Serialize + DeserializeOwned + Default> Config<TConfigData>

pub fn load(config_file_key: &str) -> Result<Self, ConfigError>

Load a config based on a key.

The file and directory creation is lazy, i.e. if the JSON file does not exist, a default config will be loaded and the file will not actually be created until there is a write.

pub fn save(&self) -> Result<(), ConfigError>

Flush config changes to disk.

pub fn data(&self) -> &TConfigData

pub fn data_mut(&mut self) -> &mut TConfigData

Trait Implementations

impl<TConfigData: Serialize + DeserializeOwned + Default + Debug> Debug for Config<TConfigData>

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

Formats the value using the given formatter.