Struct zng::config::CONFIG

pub struct CONFIG;

Represents the app main config.

Config sources must be loaded using CONFIG.load, otherwise the config only lives for the duration of the app instance.

Implementations

impl CONFIG

pub fn load(&self, source: impl AnyConfig)

Replace the config source.

Variables and bindings survive source replacement, updating to the new value or setting the new source if the key is not present in the new source.

pub fn status(&self) -> Box<dyn VarBoxed<ConfigStatus>>

Gets a read-only variable that represents the IO status of the config.

pub async fn wait_idle(&self)

Wait until status is idle (not loading nor saving).

pub fn get<T>(&self, key: impl Into<Txt>, default: T) -> Box<dyn VarBoxed<T>>

where T: ConfigValue,

Gets a variable that is bound to the config key.

The same variable is returned for multiple requests of the same key. If the loaded config is not read-only the returned variable can be set to update the config source.

The default value is used if the key is not found in the config, the default value is not inserted in the config, the key is inserted or replaced only when the returned variable updates.

pub fn insert<T>(&self, key: impl Into<Txt>, value: T) -> Box<dyn VarBoxed<T>>

where T: ConfigValue,

Gets a variable that is bound to the config key, the value is set and if the key was not present it is also inserted on the config.

Trait Implementations

impl AnyConfig for CONFIG

fn get_raw( &mut self, key: Txt, default: RawConfigValue, insert: bool, shared: bool, ) -> Box<dyn VarBoxed<RawConfigValue>>

Gets a weak typed variable to the config key.

fn contains_key(&mut self, key: Txt) -> Box<dyn VarBoxed<bool>>

Gets a read-only variable that tracks if an entry for the key is in the backing storage.

fn status(&self) -> Box<dyn VarBoxed<ConfigStatus>>

Gets a read-only variable that represents the IO status of the config.

fn remove(&mut self, key: &Txt) -> bool

Removes the key from the backing storage.

fn low_memory(&mut self)

Cleanup and flush RAM caches.

impl Config for CONFIG

fn get<T>( &mut self, key: impl Into<Txt>, default: T, insert: bool, ) -> Box<dyn VarBoxed<T>>

where T: ConfigValue,

Gets a variable that is bound to the config key.