Struct Settings 

pub struct Settings {
    pub block_write: bool,
    pub bool: HashMap<String, bool>,
    pub i32: HashMap<String, i32>,
    pub f32: HashMap<String, f32>,
    pub string: HashMap<String, String>,
    pub raw_data: HashMap<String, Vec<u8>>,
    pub vec_string: HashMap<String, Vec<String>>,
}

Snapshot of every persisted setting.

Each typed sub-map keeps its own keys; lookups never cross types, so settings.bool("X") and settings.i32("X") are independent. Lookups for a missing key return the type’s default (false, 0, "", …).

Values mutate through the typed set_* / initialize_* methods. Each successful set persists to disk immediately, unless set_block_write is set to true (used for batch updates via the set_batch! macro).

Fields

block_write: bool

When true, Self::write becomes a no-op. Used by set_batch! to coalesce many updates into a single disk write.

bool: HashMap<String, bool>

Boolean settings.

i32: HashMap<String, i32>

Signed 32-bit integer settings.

f32: HashMap<String, f32>

32-bit floating-point settings.

string: HashMap<String, String>

String settings (also used for path-shaped strings; see Self::path_buf for PathBuf access on top of the same map).

raw_data: HashMap<String, Vec<u8>>

Opaque byte-blob settings.

vec_string: HashMap<String, Vec<String>>

Lists-of-strings settings.

Implementations

impl Settings

pub fn init(as_new: bool) -> Result<Self>

Build a fresh Settings instance, loading from disk and applying per-key default initialisation.

If as_new is true the on-disk file is ignored and a fully default settings struct is returned (still applying the per-key defaults). If reading the on-disk file fails, the broken file is backed up to settings.json.bak and defaults are used — protects against sporadic read failures silently resetting every setting.

pub fn read() -> Result<Self>

Read the on-disk settings file (settings.json under config_path).

Errors if the file is missing or cannot be parsed as JSON. Most callers want Self::init instead, which falls back to defaults on failure.

pub fn write(&self) -> Result<()>

Writes the settings to disk. Does nothing if the block write flag is set.

pub fn set_block_write(&mut self, status: bool)

Disables save to disk when storing a setting. For batch operations.

pub fn bool(&self, setting: &str) -> bool

Read a bool setting; returns false if setting isn’t set.

pub fn i32(&self, setting: &str) -> i32

Read an i32 setting; returns 0 if setting isn’t set.

pub fn f32(&self, setting: &str) -> f32

Read an f32 setting; returns 0.0 if setting isn’t set.

pub fn string(&self, setting: &str) -> String

Read a String setting; returns an empty string if setting isn’t set.

pub fn path_buf(&self, setting: &str) -> PathBuf

Read a path-shaped string setting as a PathBuf; returns an empty PathBuf if setting isn’t set. Backed by the same map as Self::string.

pub fn raw_data(&self, setting: &str) -> Vec<u8>

Read a raw byte-blob setting; returns an empty Vec if setting isn’t set.

pub fn vec_string(&self, setting: &str) -> Vec<String>

Read a Vec<String> setting; returns an empty Vec if setting isn’t set.

pub fn set_bool(&mut self, setting: &str, value: bool) -> Result<()>

Set a bool setting and persist to disk (subject to block_write).

pub fn set_i32(&mut self, setting: &str, value: i32) -> Result<()>

Set an i32 setting and persist to disk (subject to block_write).

pub fn set_f32(&mut self, setting: &str, value: f32) -> Result<()>

Set an f32 setting and persist to disk (subject to block_write).

pub fn set_string(&mut self, setting: &str, value: &str) -> Result<()>

Set a String setting and persist to disk (subject to block_write).

pub fn set_path_buf(&mut self, setting: &str, value: &Path) -> Result<()>

Set a path setting (stored as a string) and persist to disk (subject to block_write).

pub fn set_raw_data(&mut self, setting: &str, value: &[u8]) -> Result<()>

Set a raw byte-blob setting and persist to disk (subject to block_write).

pub fn set_vec_string(&mut self, setting: &str, value: &[String]) -> Result<()>

Set a Vec<String> setting and persist to disk (subject to block_write).

pub fn initialize_bool(&mut self, setting: &str, value: bool)

Set a bool setting only if it isn’t already set. Used by Self::init to seed defaults without clobbering user choices.

pub fn initialize_i32(&mut self, setting: &str, value: i32)

Set an i32 setting only if it isn’t already set. See Self::initialize_bool.

pub fn initialize_f32(&mut self, setting: &str, value: f32)

Set an f32 setting only if it isn’t already set. See Self::initialize_bool.

pub fn initialize_string(&mut self, setting: &str, value: &str)

Set a String setting only if it isn’t already set. See Self::initialize_bool.

pub fn initialize_path_buf(&mut self, setting: &str, value: &Path)

Set a path setting only if it isn’t already set. See Self::initialize_bool.

pub fn initialize_raw_data(&mut self, setting: &str, value: &[u8])

Set a raw byte-blob setting only if it isn’t already set. See Self::initialize_bool.

pub fn initialize_vec_string(&mut self, setting: &str, value: &[String])

Set a Vec<String> setting only if it isn’t already set. See Self::initialize_bool.

pub fn optimizer_options(&self) -> OptimizerOptions

Project the optimiser-related boolean settings into an OptimizerOptions suitable for handing to rpfm_extensions::optimizer.

pub fn assembly_kit_path(&self, game: &GameInfo) -> Result<PathBuf>

This function returns the path where the db files from the assembly kit are stored.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate 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.

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.