Struct ConfigSet

pub struct ConfigSet {
    pub(crate) configs: BTreeMap<String, ConfigEntry>,
}

An set of Configs with values that may or may not be independent of other ConfigSets.

When constructing a ConfigSet from scratch with ConfigSet::default followed by ConfigSet::add, the values added to the ConfigSet will be independent of the values in all other ConfigSets.

When constructing a ConfigSet by cloning an existing ConfigSet, any values cloned from the original ConfigSet will be shared with the original ConfigSet. Updates to these values in one ConfigSet will be seen in the other ConfigSet, and vice versa. Any value added to the new ConfigSet via ConfigSet::add will be independent of values in the original ConfigSet, unless the new ConfigSet is later cloned.

Fields

configs: BTreeMap<String, ConfigEntry>

Implementations

impl ConfigSet

pub fn add<D: ConfigDefault>(self, config: &Config<D>) -> Self

Adds the given config to this set.

Names are required to be unique within a set, but each set is entirely independent. The same Config may be registered to multiple ConfigSets and thus have independent values (e.g. imagine a unit test executing concurrently in the same process).

Panics if a config with the same name has been previously registered to this set.

pub fn entries(&self) -> impl Iterator<Item = &ConfigEntry>

Returns the configs currently registered to this set.

pub fn entry(&self, name: &str) -> Option<&ConfigEntry>

Returns the config with name registered to this set, if one exists.

Trait Implementations

impl Clone for ConfigSet

fn clone(&self) -> ConfigSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSet

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

Formats the value using the given formatter.

impl Default for ConfigSet

fn default() -> ConfigSet

Returns the “default value” for a type.