Struct Config

pub struct Config {
    pub sections: BTreeMap<String, BTreeMap<String, String>>,
    pub general_values: BTreeMap<String, String>,
}

Represents an INI-style configuration, including both general values (not tied to any section) and sectioned key-value pairs.

You can build a Config manually using the ConfigBuilder API, load one from a file, or create defaults using macros like crate::sectioned_defaults! and crate::general_defaults!.

Fields

sections: BTreeMap<String, BTreeMap<String, String>>

general_values: BTreeMap<String, String>

Implementations

impl Config

pub fn general(&self) -> &BTreeMap<String, String>

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

pub fn get_as<T>(&self, section: Option<&str>, key: &str) -> Option<T>

where T: FromStr + Debug,

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, Error>

pub fn load_or_default<P: AsRef<Path>>(path: P, default: Config) -> Self

pub fn load_or_default_outcome<P: AsRef<Path>>( path: P, default: Config, ) -> LoadOutcome

pub fn builder() -> ConfigBuilder

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<&Self, Error>

pub fn section(&self, title: &str) -> Option<&BTreeMap<String, String>>

pub fn sections(&self) -> &BTreeMap<String, BTreeMap<String, String>>

pub fn update( &mut self, section: Option<&str>, key: &str, value: &str, ) -> &mut Self

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() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config