Struct Preferences 

pub struct Preferences<E>
where
    E: Error + Debug + From<Error> + Send + 'static,
{ /* private fields */ }

Preferences collection with a backing storage provider.

Implementations

impl<E> Preferences<E>

where E: Error + Debug + From<Error> + Send + 'static,

pub fn new( provider: Arc<PreferenceStorageProvider<E>>, account_id: Option<AccountId>, ) -> Self

Create new preferences using the given storage provider.

pub async fn load(&mut self) -> Result<(), E>

Load the preferences from storage.

pub fn len(&self) -> usize

Number of preferences.

pub fn is_empty(&self) -> bool

Whether the preferences collection is empty.

pub fn values(&self) -> &PreferenceMap

Map of preferences.

pub fn iter(&self) -> impl Iterator<Item = (&String, &Preference)>

Iterator of the preferences.

pub fn get_number(&self, key: impl AsRef<str>) -> Result<Option<&Preference>, E>

Get a number preference.

pub fn get_bool(&self, key: impl AsRef<str>) -> Result<Option<&Preference>, E>

Get a boolean preference.

pub fn get_string(&self, key: impl AsRef<str>) -> Result<Option<&Preference>, E>

Get a string preference.

pub fn get_string_list( &self, key: impl AsRef<str>, ) -> Result<Option<&Preference>, E>

Get a string list preference.

pub fn get_json_value( &self, key: impl AsRef<str>, ) -> Result<Option<&Preference>, E>

Get a JSON value preference.

pub fn get_unchecked(&self, key: impl AsRef<str>) -> Option<&Preference>

Get a preference without checking the type.

pub async fn insert(&mut self, key: String, value: Preference) -> Result<(), E>

Insert a preference.

If the preference already exists it is overwritten.

pub async fn remove( &mut self, key: impl AsRef<str>, ) -> Result<Option<Preference>, E>

Remove a preference.

pub async fn clear(&mut self) -> Result<(), E>

Clear all preferences.