Struct Config

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

Fields

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

general_values: BTreeMap<String, String>

Implementations

impl Config

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

pub fn load(filename: &str) -> Result<Self, Error>

Examples found in repository

examples/load.rs (line 5)

fn main() {
    let filename = "config.ini"; // Change as needed
    let config = Config::load(filename).expect("Failed to load config file");
    println!("{config:#?}");
}

pub fn new<'a>() -> ConfigBuilder<'a>

Examples found in repository

examples/general_manual.rs (line 4)

fn main() -> Result<(), config_tools::Error> {
    let config = Config::new()
        .set("host", "127.0.0.1")
        .set("port", "8080")
        .build();

    config.save("config-general-manual.ini")
}

examples/sectioned_manual.rs (line 4)

fn main() -> Result<(), config_tools::Error> {
    let config = Config::new()
        .section("Server")
        .set("host", "127.0.0.1")
        .set("port", "8080")
        .section("Window")
        .set("width", "720")
        .set("height", "480")
        .general()
        .set("console", "true")
        .build();

    config.save("config-sectioned-manual.ini")
}

pub fn save(&self, filename: &str) -> Result<(), Error>

Examples found in repository

examples/general_manual.rs (line 9)

fn main() -> Result<(), config_tools::Error> {
    let config = Config::new()
        .set("host", "127.0.0.1")
        .set("port", "8080")
        .build();

    config.save("config-general-manual.ini")
}

examples/general_macro.rs (line 9)

fn main() -> Result<(), config_tools::Error> {
    let mut config = config_tools::general_defaults! {
        "host" => "127.0.0.1",
        "port" => "8080",
    };

    config.update(None, "host", "0.0.0.0");

    config.save("config-general-macro.ini")
}

examples/sectioned_manual.rs (line 15)

fn main() -> Result<(), config_tools::Error> {
    let config = Config::new()
        .section("Server")
        .set("host", "127.0.0.1")
        .set("port", "8080")
        .section("Window")
        .set("width", "720")
        .set("height", "480")
        .general()
        .set("console", "true")
        .build();

    config.save("config-sectioned-manual.ini")
}

examples/sectioned_macro.rs (line 20)

fn main() -> Result<(), config_tools::Error> {
    let mut config = config_tools::sectioned_defaults! {
        {
            "console" => "true"
        }

        ["Application"] {
            "host" => "127.0.0.1",
            "port" => "8080",
        }

        ["Window"] {
            "width" => "720",
            "height" => "480",
        }
    };

    config.update(Some("Application"), "host", "0.0.0.0");

    config.save("config-sectioned-macro.ini")
}

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

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

Examples found in repository

examples/general_macro.rs (line 7)

fn main() -> Result<(), config_tools::Error> {
    let mut config = config_tools::general_defaults! {
        "host" => "127.0.0.1",
        "port" => "8080",
    };

    config.update(None, "host", "0.0.0.0");

    config.save("config-general-macro.ini")
}

examples/sectioned_macro.rs (line 18)

fn main() -> Result<(), config_tools::Error> {
    let mut config = config_tools::sectioned_defaults! {
        {
            "console" => "true"
        }

        ["Application"] {
            "host" => "127.0.0.1",
            "port" => "8080",
        }

        ["Window"] {
            "width" => "720",
            "height" => "480",
        }
    };

    config.update(Some("Application"), "host", "0.0.0.0");

    config.save("config-sectioned-macro.ini")
}

Trait Implementations

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 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.