Struct SubSettings 

pub struct SubSettings<S: StorageBackend = JsonStorage> { /* private fields */ }

Sub-settings for per-entity configuration. Handler for a single sub-settings type

Implementations

impl<S: StorageBackend + Clone + 'static> SubSettings<S>

pub fn new( config_dir: &Path, config: SubSettingsConfig, storage: S, credential_manager: Option<CredentialManager>, ) -> Result<Self>

Create a new SubSettings instance

Arguments

• config_dir - The directory where the configuration files are stored
• config - The configuration for the sub-settings
• storage - The storage backend to use

Errors

Returns an error if:

• The cache strategy is invalid
• Profile migration fails
• File operations fail

pub fn root_path(&self) -> PathBuf

pub fn is_single_file(&self) -> bool

pub fn profiles_enabled(&self) -> bool

pub fn extension(&self) -> &str

pub fn schema_metadata(&self) -> Option<Arc<HashMap<String, SettingMetadata>>>

pub fn storage(&self) -> &S

pub fn invalidate_cache(&self)

pub fn profiles(&self) -> Result<&ProfileManager<S>>

Get the profile manager if enabled

Errors

Returns an error if profiles are not enabled for this sub-settings type.

pub fn switch_profile(&self, name: &str) -> Result<()>

Switch to a different profile

Arguments

• name - The name of the profile to switch to

Errors

Returns an error if:

• Profiles are not enabled
• Profile switch fails
• Store re-creation fails

pub fn set_on_change<F>(&self, callback: F) -> Result<()>

where F: Fn(&str, SubSettingsAction) + Send + Sync + 'static,

Set the change callback

Arguments

• callback - The callback to set

Errors

Returns an error if the internal lock is poisoned.

pub fn set_field<T: Serialize + Sync>( &self, name: &str, field_path: &str, value: &T, ) -> Result<()>

Update a single field in a sub-settings entry.

This performs a read-modify-write on one entry:

• Loads existing entry (or {} if missing)
• Sets the provided field path (supports dot notation)
• Saves through set(), so schema validation and secret handling still apply

Errors

Returns an error if serialization fails, schema validation fails, or store write fails.

pub fn get_value(&self, name: &str) -> Result<Value>

Get a raw Value from the store

Arguments

• name - The name of the setting to retrieve

Errors

Returns an error if the setting is not found or store access fails.

pub fn get<T: DeserializeOwned>(&self, name: &str) -> Result<T>

Get and deserialize a value from the store

Arguments

• name - The name of the setting to retrieve

Errors

Returns an error if:

• The setting is not found
• Deserialization fails
• Store access fails

pub fn set<T: Serialize + Sync>(&self, name: &str, value: &T) -> Result<()>

Serialize and set a value in the store

Arguments

• name - The name of the setting to set
• value - The value to set

Errors

Returns an error if:

• Serialization fails
• Store write fails

pub fn delete(&self, name: &str) -> Result<()>

Delete a value from the store

Arguments

• name - The name of the setting to delete

Errors

Returns an error if store write fails.

pub fn list(&self) -> Result<Vec<String>>

List all sub-setting keys

Errors

Returns an error if the store cannot be read.

pub fn get_all_values(&self) -> Result<HashMap<String, Value>>

Get all sub-setting entries as a map

Returns a HashMap<String, Value> with all entry names as keys and their deserialized values. Entries that fail to load are silently skipped.

Errors

Returns an error if the store cannot be read.

pub fn exists(&self, name: &str) -> Result<bool>

Check if a sub-setting key exists

Arguments

• name - The name of the setting to check

Errors

Returns an error if the store cannot be read or if an unexpected error occurs during lookup.

pub fn directory(&self) -> PathBuf

pub fn file_path(&self) -> Option<PathBuf>