Struct zng::config::SwitchConfig

pub struct SwitchConfig { /* private fields */ }

Represents multiple config sources that are matched by key.

When a config key is requested a closure defined for each config case in the switch is called, if the closure returns a key the config case is used.

Note that the returned config variables are linked directly with the matched configs, and if none matches returns from a fallback MemoryConfig. If a config is pushed after no match the already returned variable will not update to link with the new config.

Implementations

impl SwitchConfig

pub fn new() -> SwitchConfig

New default empty.

pub fn push( &mut self, match_key: impl Fn(&Txt) -> Option<Txt> + Send + Sync + 'static, config: impl AnyConfig, )

Push a config case on the switch.

The match_key closure will be called after the match of previous configs, if it returns Some(key) the key will be used on the config to retrieve the value variable.

pub fn push_prefix(&mut self, prefix: impl Into<Txt>, config: impl AnyConfig)

Push a config case matched by a key prefix.

The prefix is stripped from the key before it is passed on to the config.

Always matches the config if the prefix is empty.

pub fn with( self, match_key: impl Fn(&Txt) -> Option<Txt> + Send + Sync + 'static, config: impl AnyConfig, ) -> SwitchConfig

Push the config and return.

See push for more details.

pub fn with_prefix( self, prefix: impl Into<Txt>, config: impl AnyConfig, ) -> SwitchConfig

Push the config and return.

See push_prefix for more details.

Trait Implementations

impl AnyConfig for SwitchConfig

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

Gets a read-only variable that represents the IO status of the 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 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 SwitchConfig

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.

impl Default for SwitchConfig

fn default() -> SwitchConfig

Returns the “default value” for a type.