Struct Config 

pub struct Config {
    pub path: PathBuf,
    /* private fields */
}

Fields

path: PathBuf

Implementations

impl Config

pub fn new<T: AsRef<str>>(name: T) -> Result<Self>

Create a new system config.

Examples found in repository

examples/write.rs (line 4)

fn main() {
    let mut config = Config::new("system-config-example").unwrap();

    config.insert("key1", "value1");
    config.insert("key2", "value2");

    config.write().unwrap();
}

examples/read.rs (line 4)

fn main() {
    let config = Config::new("system-config-example").unwrap();

    let key1 = config.get("key1").unwrap();
    let key2 = config.get("key2").unwrap();

    println!("key1: {}", key1);
    println!("key2: {}", key2);
}

examples/multiple.rs (line 12)

fn write() {
    let mut config = Config::new("system-config-multiple-example").unwrap();

    config.write_insert("1", "value 1").unwrap();
    config.write_insert("2", "value 2").unwrap();
    config.write_insert("3", "value 3").unwrap();

    println!("wrote:\n  1    value 1\n  2    value 2\n  3    value 3\n");
}

fn read() {
    let mut config = Config::new("system-config-multiple-example").unwrap();

    let x1 = config.read_get("1").unwrap().unwrap();
    let x2 = config.read_get("2").unwrap().unwrap();
    let x3 = config.read_get("3").unwrap().unwrap();

    println!("read:\n  1    {}\n  2    {}\n  3    {}\n", x1, x2, x3);
}

pub fn write_clear_by_name<T: AsRef<str>>(name: T) -> Result<()>

Clear a config by name and sync it with the disk.

Examples found in repository

examples/clear.rs (line 4)

fn main() {
    Config::write_clear_by_name("system-config-example").unwrap();
    Config::write_clear_by_name("system-config-multiple-example").unwrap();
}

pub fn read(&mut self) -> Result<()>

Update the config from disk.

pub fn write(&self) -> Result<()>

Update the disk from the config.

Examples found in repository

examples/write.rs (line 9)

fn main() {
    let mut config = Config::new("system-config-example").unwrap();

    config.insert("key1", "value1");
    config.insert("key2", "value2");

    config.write().unwrap();
}

pub fn insert<T: AsRef<str>>(&mut self, key: T, value: T)

Insert a key-value pair into the config.

Examples found in repository

examples/write.rs (line 6)

fn main() {
    let mut config = Config::new("system-config-example").unwrap();

    config.insert("key1", "value1");
    config.insert("key2", "value2");

    config.write().unwrap();
}

pub fn get<T: AsRef<str>>(&self, query: T) -> Option<String>

Get a value for a key.

Examples found in repository

examples/read.rs (line 6)

fn main() {
    let config = Config::new("system-config-example").unwrap();

    let key1 = config.get("key1").unwrap();
    let key2 = config.get("key2").unwrap();

    println!("key1: {}", key1);
    println!("key2: {}", key2);
}

pub fn clear(&mut self)

Clear all data in the config.

pub fn write_insert<T: AsRef<str>>(&mut self, key: T, value: T) -> Result<()>

Insert a key-value pair into the config and write to disk.

Examples found in repository

examples/multiple.rs (line 14)

fn write() {
    let mut config = Config::new("system-config-multiple-example").unwrap();

    config.write_insert("1", "value 1").unwrap();
    config.write_insert("2", "value 2").unwrap();
    config.write_insert("3", "value 3").unwrap();

    println!("wrote:\n  1    value 1\n  2    value 2\n  3    value 3\n");
}

pub fn read_get<T: AsRef<str>>(&mut self, query: T) -> Result<Option<String>>

Read the system config and get a value for a key.

Examples found in repository

examples/multiple.rs (line 24)

fn read() {
    let mut config = Config::new("system-config-multiple-example").unwrap();

    let x1 = config.read_get("1").unwrap().unwrap();
    let x2 = config.read_get("2").unwrap().unwrap();
    let x3 = config.read_get("3").unwrap().unwrap();

    println!("read:\n  1    {}\n  2    {}\n  3    {}\n", x1, x2, x3);
}

pub fn write_clear(&mut self) -> Result<()>

Clear all data in the config and write to disk.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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 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 StructuralPartialEq for Config