Struct Setting 

pub struct Setting<T> {
    repository: Arc<dyn Repository<SettingItem>>,
    key: Key<T>,
}

A handle to a single setting value in storage.

This type provides async methods to get, update, and delete the setting value. Obtained via StateClient::setting().

Example

use bitwarden_state::register_setting_key;

register_setting_key!(const THEME: String = "theme");

let setting = client.platform().state().setting(THEME)?;

// Get the current value
let value: Option<String> = setting.get().await?;

// Update the value
setting.update("dark".to_string()).await?;

// Delete the value
setting.delete().await?;

Fields

repository: Arc<dyn Repository<SettingItem>>

key: Key<T>

Implementations

impl<T> Setting<T>

pub fn new(repository: Arc<dyn Repository<SettingItem>>, key: Key<T>) -> Self

Create a new setting handle from a repository and key.

pub async fn get(&self) -> Result<Option<T>, SettingsError>

where T: for<'de> Deserialize<'de>,

Get the current value of this setting.

Returns None if the setting doesn’t exist in storage.

Errors

Returns an error if deserialization fails, which may indicate:

• Schema evolution problems (type definition changed)
• Data corruption
• Type mismatch (wrong Key<T> type for stored data)

pub async fn update(&self, value: T) -> Result<(), SettingsError>

where T: Serialize,

Update (or create) this setting with a new value.

pub async fn delete(&self) -> Result<(), SettingsError>

Delete this setting from storage.