Struct librustconfig::config::Config

pub struct Config { /* fields omitted */ }

Configuration file.

Implementations

impl Config

pub fn new() -> Config

Constructor. Create new Config struct.

Example

use librustconfig::config::Config;
 
let cfg = Config::new();

pub fn load_from_file(&mut self, file_name: &Path) -> Result<(), Errors>

Load config file from file and parse it.

Example

use librustconfig::config::Config;
use std::path::Path;
 
let mut cfg = Config::new();
if cfg.load_from_file(Path::new("test.cfg")).is_ok() {
    // ...
}

pub fn load_from_string<S>(&mut self, config_string: S) -> Result<(), Errors> where
    S: Into<String>, 

Parse configuration from string.

Example

use librustconfig::config::Config;
 
let mut cfg = Config::new();
if cfg.load_from_string("root { value = 1 }").is_ok() {
    // ...
}

pub fn save_to_file(&mut self, file_name: &Path) -> Result<(), Errors>

Save current config to file.

Example

use librustconfig::config::Config;
use std::path::Path;
use std::fs;
 
let mut cfg = Config::new();
if cfg.save_to_file(Path::new("test.cfg")).is_ok() {
     // ...
}
fs::remove_file(Path::new("test.cfg"));

pub fn include_dir(&mut self, path: &Path)

Set current config include directory.

Example

use librustconfig::config::Config;
use std::path::Path;
 
let mut cfg = Config::new();
cfg.include_dir(Path::new("/config"));

pub fn value<S>(&self, path: S) -> Option<OptionReader> where
    S: Into<String>, 

Read value from path.

Example

use librustconfig::config::Config;
 
let cfg = Config::new();
match cfg.value("root.value") {
    Some(val) => { /* ... */ },
    None => { /* ... */ }
}

pub fn create_section<S>(&self, path: S) -> Option<OptionWriter> where
    S: Into<String>, 

Create new group section.

Example

use librustconfig::config::Config;
 
let cfg = Config::new();
match cfg.create_section("root") {
    Some(s) => { /* ... */ },
    None => { /* ... */ }
}

Trait Implementations

impl Drop for Config

Destructor. Clear config and delete all allocated memory data.

fn drop(&mut self)

Executes the destructor for this type.