Struct ConfigBundle 

pub struct ConfigBundle { /* private fields */ }

A merged bundle of configuration for use with components that watches for updates to all named configs specified.

There are two main ways to get config from this struct:

1. You can call get_config which will return a reference to the merged config. This is mainly for use in components, which will fetch needed config on demand
2. You can call changed which will return a reference to the merged config. This is for use in situations where you want to be notified when a config changes, such as for a provider that needs to be notified when a config changes

Implementations

impl ConfigBundle

pub async fn get_config(&self) -> RwLockReadGuard<'_, HashMap<String, String>>

Returns a reference to the merged config behind a lock guard. This guard must be dropped when you are no longer consuming the config

pub async fn changed( &mut self, ) -> Result<RwLockReadGuard<'_, HashMap<String, String>>>

Waits for the config to change and returns a reference to the merged config behind a lock guard. This guard must be dropped when you are no longer consuming the config.

Please note that this requires a mutable borrow in order to manage underlying notification acknowledgement.

pub fn config_names(&self) -> &Vec<String>

Returns a reference to the ordered list of config names handled by this bundle

Trait Implementations

impl Clone for ConfigBundle

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigBundle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.