Trait config::Configuration

pub trait Configuration {
    fn get(&self, key: &str) -> Option<&str>;
    fn section(&self, key: &str) -> Box<dyn ConfigurationSection>;
    fn children(&self) -> Vec<Box<dyn ConfigurationSection>>;
    fn reload_token(&self) -> Box<dyn ChangeToken>;
    fn iter_relative(
        &self,
        make_paths_relative: bool
    ) -> Box<dyn Iterator<Item = (String, String)>>;

    fn as_section(&self) -> Option<&dyn ConfigurationSection> { ... }
    fn iter(&self) -> Box<dyn Iterator<Item = (String, String)>> { ... }
}

Defines the behavior of a configuration.

Required Methods

fn get(&self, key: &str) -> Option<&str>

Gets the configuration value.

Arguments

• key - The configuration key

fn section(&self, key: &str) -> Box<dyn ConfigurationSection>

Gets a configuration section with the specified key.

fn children(&self) -> Vec<Box<dyn ConfigurationSection>>

Gets the sequence of child configuration sections.

fn reload_token(&self) -> Box<dyn ChangeToken>

Returns a change token that can be used to observe when this configuration is reloaded.

fn iter_relative(
    &self,
    make_paths_relative: bool
) -> Box<dyn Iterator<Item = (String, String)>>

Gets an iterator of the key/value pairs within the configuration.

Arguments

• make_paths_relative - If true, the child keys returned will have the current configuration’s path trimmed from the front

Provided Methods

fn as_section(&self) -> Option<&dyn ConfigurationSection>

Attempts to convert the configuration as a configuration section.

fn iter(&self) -> Box<dyn Iterator<Item = (String, String)>>

Gets an iterator of the key/value pairs within the configuration.

Implementors

impl Configuration for DefaultConfigurationRoot

impl Configuration for DefaultConfigurationSection