Struct encrypt_config::config::Config

pub struct Config { /* private fields */ }

A struct that can be used to cache configuration values. This behaves like a native cache in CPU:

1. If cache hit, return the cached value when reading, while update the cached value and then write back when writing.
2. If cache miss, load the cached value from the source to cache when reading, while write and then load when writing.

To avoid entering the password during testing, you can enable mock feature. This can always return the same Encrypter during each test.

Implementations

impl Config

pub fn new() -> Self

Create a new Config cache.

pub fn get<T>(&self) -> ConfigRef<'_, T>

where T: Source + Any + Send + Sync,

Get an immutable ref from the config. If the value is not found, it will be created with the default value. See ConfigRef for more details.

pub fn get_mut<T>(&self) -> ConfigMut<'_, T>

where T: Source + Any + Send + Sync,

Get a mutable ref from the config. If the value is not found, it will be created with the default value. See ConfigMut for more details.

pub fn take<T>(&self) -> T

where T: Source + Any + Send + Sync,

Take the ownership of the config value. If the value is not found, it will be created with the default value. This will remove the value from the config.

pub fn get_many<T>(&self) -> <T as Cacheable<((),)>>::Ref<'_>

where T: Cacheable<((),)> + Any + Send + Sync,

Get many immutable refs from the config.

T: (T1, T2, T3,)

If the value is not found, it will be created with the default value. See ConfigRef for more details.

pub fn get_mut_many<T>(&self) -> <T as Cacheable<((),)>>::Mut<'_>

where T: Cacheable<((),)> + Any + Send + Sync,

Get many mutable refs from the config.

T: (T1, T2, T3,)

If the value is not found, it will be created with the default value. See ConfigMut for more details.

pub fn take_many<T>(&self) -> <T as Cacheable<((),)>>::Owned

where T: Cacheable<((),)> + Any + Send + Sync,

Take the ownerships of the config value.

T: (T1, T2, T3,)

If the value is not found, it will be created with the default value. This will remove the value from the config.

pub fn save<T>(&self, value: T) -> ConfigResult<()>

where T: Source + Any + Send + Sync,

Save the config value manually. Note that the changes you made through ConfigMut will be saved as leaving the scope automatically.

Ideally, it’s better to change cache first and then set dirty flag when writing, and save the value when the cache drops. However, this is hard to implement for manual saving by now. So, one is supposed to use get and get_mut to change the value.

Trait Implementations

impl Default for Config

fn default() -> Self

Create an empty Config cache.