Struct librustconfig::config::OptionWriter

pub struct OptionWriter { /* fields omitted */ }

Writer for configuration option.

Implementations

impl OptionWriter

pub fn delete(&self) -> Result<(), Errors>

Delete current config element.

Example

use librustconfig::config::Config;
 
let cfg = Config::new();
match cfg.create_section("group") {
    Some(group) => {
        /* ... */
        if !group.delete().is_ok() {
            /* ... */
        }
    },
    None => { /* ... */ }
}

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

Create new group section.

Examples

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

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

Create new array group section.

Examples

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

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

Create new list group section.

Examples

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

pub fn write_int32<S>(&self, name: S, value: i32) -> Option<OptionWriter> where
    S: Into<String>, 

Add new integer value to current group.

Example

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

pub fn write_int64<S>(&self, name: S, value: i64) -> Option<OptionWriter> where
    S: Into<String>, 

Add new int64 value to current group.

Example

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

pub fn write_float64<S>(&self, name: S, value: f64) -> Option<OptionWriter> where
    S: Into<String>, 

Add new float value to current group.

Example

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

pub fn write_bool<S>(&self, name: S, value: bool) -> Option<OptionWriter> where
    S: Into<String>, 

Add new boolean value to current group.

Example

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

pub fn write_string<S>(&self, name: S, value: S) -> Option<OptionWriter> where
    S: Into<String>, 

Add new string value to current group.

Example

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

Trait Implementations

impl Clone for OptionWriter

fn clone(&self) -> OptionWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OptionWriter