Struct ini::Properties

pub struct Properties { /* private fields */ }

Properties type (key-value pairs)

Implementations

impl Properties

pub fn new() -> Properties

Create an instance

pub fn len(&self) -> usize

Get the number of the properties

pub fn is_empty(&self) -> bool

Check if properties has 0 elements

pub fn iter(&self) -> impl DoubleEndedIterator<Item = (&str, &str)>

Get an iterator of the properties

Examples found in repository

examples/test.rs (line 34)

fn main() {
    let mut conf = Ini::new();
    conf.with_section(None::<String>).set("encoding", "utf-8");
    conf.with_section(Some("User"))
        .set("name", "Raspberry树莓")
        .set("value", "Pi");
    conf.with_section(Some("Library"))
        .set("name", "Sun Yat-sen U")
        .set("location", "Guangzhou=world\x0ahahaha");

    conf.section_mut(Some("Library")).unwrap().insert("seats", "42");

    println!("---------------------------------------");
    println!("Writing to file {:?}\n", CONF_FILE_NAME);
    conf.write_to(&mut stdout()).unwrap();

    conf.write_to_file(CONF_FILE_NAME).unwrap();

    println!("----------------------------------------");
    println!("Reading from file {:?}", CONF_FILE_NAME);
    let i = Ini::load_from_file(CONF_FILE_NAME).unwrap();

    println!("Iterating");
    let general_section_name = "__General__";
    for (sec, prop) in i.iter() {
        let section_name = sec.as_ref().unwrap_or(&general_section_name);
        println!("-- Section: {:?} begins", section_name);
        for (k, v) in prop.iter() {
            println!("{}: {:?}", k, v);
        }
    }
    println!();

    let section = i.section(Some("User")).unwrap();
    println!("name={}", section.get("name").unwrap());
    println!("conf[User][name]={}", &i["User"]["name"]);
    println!("General Section: {:?}", i.general_section());
}

pub fn contains_key<S: AsRef<str>>(&self, s: S) -> bool

Return true if property exist

pub fn insert<K, V>(&mut self, k: K, v: V)where K: Into<String>, V: Into<String>,

Insert (key, value) pair by replace

Examples found in repository

examples/test.rs (line 17)

fn main() {
    let mut conf = Ini::new();
    conf.with_section(None::<String>).set("encoding", "utf-8");
    conf.with_section(Some("User"))
        .set("name", "Raspberry树莓")
        .set("value", "Pi");
    conf.with_section(Some("Library"))
        .set("name", "Sun Yat-sen U")
        .set("location", "Guangzhou=world\x0ahahaha");

    conf.section_mut(Some("Library")).unwrap().insert("seats", "42");

    println!("---------------------------------------");
    println!("Writing to file {:?}\n", CONF_FILE_NAME);
    conf.write_to(&mut stdout()).unwrap();

    conf.write_to_file(CONF_FILE_NAME).unwrap();

    println!("----------------------------------------");
    println!("Reading from file {:?}", CONF_FILE_NAME);
    let i = Ini::load_from_file(CONF_FILE_NAME).unwrap();

    println!("Iterating");
    let general_section_name = "__General__";
    for (sec, prop) in i.iter() {
        let section_name = sec.as_ref().unwrap_or(&general_section_name);
        println!("-- Section: {:?} begins", section_name);
        for (k, v) in prop.iter() {
            println!("{}: {:?}", k, v);
        }
    }
    println!();

    let section = i.section(Some("User")).unwrap();
    println!("name={}", section.get("name").unwrap());
    println!("conf[User][name]={}", &i["User"]["name"]);
    println!("General Section: {:?}", i.general_section());
}

pub fn append<K, V>(&mut self, k: K, v: V)where K: Into<String>, V: Into<String>,

Append key with (key, value) pair

pub fn get<S: AsRef<str>>(&self, s: S) -> Option<&str>

Get the first value associate with the key

Examples found in repository

examples/test.rs (line 41)

fn main() {
    let mut conf = Ini::new();
    conf.with_section(None::<String>).set("encoding", "utf-8");
    conf.with_section(Some("User"))
        .set("name", "Raspberry树莓")
        .set("value", "Pi");
    conf.with_section(Some("Library"))
        .set("name", "Sun Yat-sen U")
        .set("location", "Guangzhou=world\x0ahahaha");

    conf.section_mut(Some("Library")).unwrap().insert("seats", "42");

    println!("---------------------------------------");
    println!("Writing to file {:?}\n", CONF_FILE_NAME);
    conf.write_to(&mut stdout()).unwrap();

    conf.write_to_file(CONF_FILE_NAME).unwrap();

    println!("----------------------------------------");
    println!("Reading from file {:?}", CONF_FILE_NAME);
    let i = Ini::load_from_file(CONF_FILE_NAME).unwrap();

    println!("Iterating");
    let general_section_name = "__General__";
    for (sec, prop) in i.iter() {
        let section_name = sec.as_ref().unwrap_or(&general_section_name);
        println!("-- Section: {:?} begins", section_name);
        for (k, v) in prop.iter() {
            println!("{}: {:?}", k, v);
        }
    }
    println!();

    let section = i.section(Some("User")).unwrap();
    println!("name={}", section.get("name").unwrap());
    println!("conf[User][name]={}", &i["User"]["name"]);
    println!("General Section: {:?}", i.general_section());
}

pub fn get_all<S: AsRef<str>>( &self, s: S ) -> impl DoubleEndedIterator<Item = &str>

Get all values associate with the key

pub fn remove<S: AsRef<str>>(&mut self, s: S) -> Option<String>

Remove the property with the first value of the key

pub fn remove_all<'a, S: AsRef<str>>( &'a mut self, s: S ) -> impl DoubleEndedIterator<Item = String> + 'a

Remove the property with all values with the same key

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Properties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Properties

fn default() -> Properties

Returns the “default value” for a type.

impl<S: AsRef<str>> Index<S> for Properties

type Output = str

The returned type after indexing.

fn index(&self, index: S) -> &str

Performs the indexing (container[index]) operation.

impl PartialEq<Properties> for Properties

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Properties