Struct arc_util::settings::Settings

pub struct Settings { /* private fields */ }

Settings state.

Implementations

impl Settings

pub fn empty(file: impl Into<PathBuf>) -> Self

Creates new empty settings.

pub fn from_file(file: impl AsRef<Path>) -> Self

Creates new settings from a file.

pub fn load_file(&mut self) -> bool

Loads the settings from the settings file.

This will return false if something fails.

pub fn save_file(&self)

Saves settings to the settings file.

This may silently fail.

pub fn config_path(file: impl AsRef<Path>) -> Option<PathBuf>

Returns the path to the config file.

pub fn load_data<T>(&mut self, id: impl AsRef<str>) -> Option<T>

where T: DeserializeOwned,

Loads data from the settings map.

pub fn store_data(&mut self, id: impl Into<String>, data: impl Serialize)

Stores data in the settings map.

Silently fails if the data fails serialization.

pub fn load_component<T>(&mut self, component: &mut T)

where T: HasSettings,

Loads a component’s settings from the settings map.

pub fn store_component<T>(&mut self, component: &T)

where T: HasSettings,

Stores a component’s settings in the settings map.

Silently fails if the component’s settings fail serialization.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.