config

Trait ConfigurationProvider

Source 
pub trait ConfigurationProvider {
    // Required methods
    fn get(&self, key: &str) -> Option<Value>;
    fn child_keys(
        &self,
        earlier_keys: &mut Vec<String>,
        parent_path: Option<&str>,
    );

    // Provided methods
    fn name(&self) -> &str { ... }
    fn reload_token(&self) -> Box<dyn ChangeToken> { ... }
    fn load(&mut self) -> LoadResult { ... }
}
Expand description

Defines the behavior of an object that provides configuration key/values for an application.

Required Methods§

Source

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

Attempts to get a configuration value with the specified key.

§Arguments
  • key - The key of the value to retrieve
Source

fn child_keys(&self, earlier_keys: &mut Vec<String>, parent_path: Option<&str>)

Gets the immediate descendent configuration keys for a given parent path based on this ConfigurationProvider and the set of keys returned by all of the preceding ConfigurationProvider.

§Arguments
  • earlier_keys - The sequence of keys returned by preceding provider for the same parent path
  • parent_path - The optional parent path to evaluate

Provided Methods§

Source

fn name(&self) -> &str

Gets the name of the provider.

Source

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

Returns a ChangeToken if this provider supports change tracking.

Source

fn load(&mut self) -> LoadResult

Loads the configuration values from the implemented source.

Implementors§