Struct PersistedValue 

pub struct PersistedValue<K: PersistedValueKey> {
    backend: Arc<dyn PersistedValueTrait<K::Value>>,
    _marker: PhantomData<K>,
}

A handle to a single persisted value in storage.

This type provides async methods to get, update, and delete the persisted value. Obtained via StateClient::value(), or injected with #[derive(FromClient)].

Every failed operation is logged with tracing::error!, so callers that discard an error don’t need to log it themselves. try_get finding no value is not a failure.

Example

use bitwarden_state::register_persisted_value;

register_persisted_value!(THEME: String = "theme");

let value = client.platform().state().value::<THEME>();

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

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

// Delete the value
value.remove().await?;

Fields

backend: Arc<dyn PersistedValueTrait<K::Value>>

_marker: PhantomData<K>

Implementations

impl<K: PersistedValueKey> PersistedValue<K>

pub fn new(backend: Arc<dyn PersistedValueTrait<K::Value>>) -> Self

Create a new persisted value handle from a backend.

The backend is already bound to a single key, so it decides where the value is stored.

pub async fn get(&self) -> Result<K::Value, PersistedValueError>

Get the current value, failing with PersistedValueError::ValueNotFound if it doesn’t exist in storage. Use Self::try_get where absence is an expected outcome.

pub async fn try_get(&self) -> Result<Option<K::Value>, PersistedValueError>

Get the current value.

Returns None if the value 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 (two keys sharing a key name)

pub async fn set(&self, value: K::Value) -> Result<(), PersistedValueError>

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

pub async fn remove(&self) -> Result<(), PersistedValueError>

Delete this persisted value from storage.

Trait Implementations

impl<K: PersistedValueKey> Clone for PersistedValue<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.