Struct encrypt_config::Config

pub struct Config { /* private fields */ }

A struct that can be used to store configuration values.

Example

See Source, PersistSource, SecretSource

Implementations

impl Config

pub fn new(secret_name: impl AsRef<str>) -> Self

Create a new Config struct.

Arguments

• config_name - The name of the rsa private key stored by keyring. Only needed when feature secret is on.

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

pub fn get<K, R>(&self, key: K) -> ConfigResult<R>

where K: AsRef<str>, R: DeserializeOwned,

Get a value from the config.

Arguments

• key - The key of the value to get.

R must implement serde::de::DeserializeOwned, because this crate stores seriliazed data.

pub fn add_source(&mut self, source: impl Source) -> ConfigResult<()>

Add a source to the config. The source must implement Source trait, which is for normal config that does not need to be encrypted or persisted.

pub fn add_persist_source( &mut self, source: impl PersistSource ) -> ConfigResult<()>

Available on crate feature persist only.

Add a persist source to the config. The source must implement PersistSource trait, which is for config that needs to be persisted.

pub fn add_secret_source( &mut self, source: impl SecretSource ) -> ConfigResult<()>

Available on crate feature secret only.

Add a secret source to the config. The source must implement SecretSource trait, which is for config that needs to be encrypted and persisted.

pub fn upgrade_all<'v, K, V, KV>(&mut self, kv: KV) -> ConfigResult<()>

where K: AsRef<str>, V: Serialize + 'v, KV: IntoIterator<Item = (K, &'v V)>,

Upgrade all values in the config. The keys must already exist. If not, those key-values before the first not existing one will be upgraded, and those after will be omitted.

pub fn upgrade<K, V>(&mut self, key: K, value: &V) -> ConfigResult<()>

where K: AsRef<str>, V: Serialize,

Available on crate feature persist only.

Upgrade a value in the config. The key must already exist.

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.