Struct cfg_lib::config::Config

pub struct Config {
    pub no_duplicates: bool,
    // some fields omitted
}

Represents a CFG configuration.

Fields

no_duplicates: bool

If true, loaded configurations aren't allowed to have duplicate keys. If false, duplicate keys are allowed, and values encountered later overwrite values encountered earlier for the same key.

Methods

impl Config

pub fn new() -> Self

Return an empty configuration with default settings.

pub fn from_file(file_path: &str) -> StdResult<Self, ConfigError>

Return a new configuration loaded from the file named by file_path.

pub fn add_include(&mut self, dir: &str)

Add the directory dir to the end of the include path.

pub fn load_from_file(&mut self, file_path: &str) -> StdResult<(), ConfigError>

Load the configuration from the file named by file_path.

pub fn load(&mut self, r: Box<dyn Read>) -> StdResult<(), ConfigError>

Load the configuration from the reader r.

pub fn set_context(&mut self, context: HashMap<String, Value>)

Set the given hashmap context as the place to look up identifiers encountered in the configuration.

pub fn contains_key(&self, key: &str) -> bool

Returns true if this configuration contains the simple key key (i.e. not a path), else false.

pub fn as_mapping(
    &self,
    unwrap_configs: bool
) -> StdResult<HashMap<String, Value>, ConfigError>

Convert the configuration to a HashMap.

If unwrap_configs is true, nested configurations are also converted to mappings. Otherwise, they are left as is.

pub fn get(&self, key: &str) -> StdResult<Value, ConfigError>

Returns the value for the specified configuration key.

key can either be an identifier or a valid path.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Display for Config

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

Formats the value using the given formatter.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl StructuralPartialEq for Config