Struct ini::Ini

pub struct Ini { /* fields omitted */ }

Ini struct

Implementations

impl Ini

pub fn new() -> Ini

Create an instance

pub fn with_section<S>(&mut self, section: Option<S>) -> SectionSetter<'_> where
    S: Into<String>, 

Set with a specified section, None is for the general section

pub fn with_general_section(&mut self) -> SectionSetter<'_>

Set with general section, a simple wrapper of with_section(None::<String>)

pub fn general_section(&self) -> &Properties

Get the immmutable general section

pub fn general_section_mut(&mut self) -> &mut Properties

Get the mutable general section

pub fn section<S>(&self, name: Option<S>) -> Option<&Properties> where
    S: Into<String>, 

Get a immutable section

pub fn section_mut<S>(&mut self, name: Option<S>) -> Option<&mut Properties> where
    S: Into<String>, 

Get a mutable section

pub fn section_all<S>(
    &self,
    name: Option<S>
) -> impl Iterator<Item = &Properties> where
    S: Into<String>, 

Get all sections immutable with the same key

pub fn section_all_mut<S>(
    &mut self,
    name: Option<S>
) -> impl Iterator<Item = &mut Properties> where
    S: Into<String>, 

Get all sections mutable with the same key

pub fn entry(&mut self, name: Option<String>) -> SectionEntry<'_>

Get the entry

pub fn clear(&mut self)

Clear all entries

pub fn sections(&self) -> impl Iterator<Item = Option<&str>>

Iterate with sections

pub fn set_to<S>(&mut self, section: Option<S>, key: String, value: String) where
    S: Into<String>, 

Set key-value to a section

pub fn get_from<'a, S>(
    &'a self,
    section: Option<S>,
    key: &str
) -> Option<&'a str> where
    S: Into<String>, 

Get the first value from the sections with key

Example:

use ini::Ini;
let input = "[sec]\nabc = def\n";
let ini = Ini::load_from_str(input).unwrap();
assert_eq!(ini.get_from(Some("sec"), "abc"), Some("def"));

pub fn get_from_or<'a, S>(
    &'a self,
    section: Option<S>,
    key: &str,
    default: &'a str
) -> &'a str where
    S: Into<String>, 

Get the first value from the sections with key, return the default value if it does not exist

Example:

use ini::Ini;
let input = "[sec]\n";
let ini = Ini::load_from_str(input).unwrap();
assert_eq!(ini.get_from_or(Some("sec"), "key", "default"), "default");

pub fn get_from_mut<'a, S>(
    &'a mut self,
    section: Option<S>,
    key: &str
) -> Option<&'a mut str> where
    S: Into<String>, 

Get the first mutable value from the sections with key

pub fn delete<S>(&mut self, section: Option<S>) -> Option<Properties> where
    S: Into<String>, 

Delete the first section with key, return the properties if it exists

pub fn delete_from<S>(
    &mut self,
    section: Option<S>,
    key: &str
) -> Option<String> where
    S: Into<String>, 

Delete the key from the section, return the value if key exists or None

pub fn len(&self) -> usize

Total sections count

pub fn is_empty(&self) -> bool

Check if object coutains no section

impl Ini

pub fn write_to_file<P: AsRef<Path>>(&self, filename: P) -> Result<()>

Write to a file

pub fn write_to_file_policy<P: AsRef<Path>>(
    &self,
    filename: P,
    policy: EscapePolicy
) -> Result<()>

Write to a file

pub fn write_to_file_opt<P: AsRef<Path>>(
    &self,
    filename: P,
    opt: WriteOption
) -> Result<()>

Write to a file with options

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Write to a writer

pub fn write_to_policy<W: Write>(
    &self,
    writer: &mut W,
    policy: EscapePolicy
) -> Result<()>

Write to a writer

pub fn write_to_opt<W: Write>(
    &self,
    writer: &mut W,
    opt: WriteOption
) -> Result<()>

Write to a writer with options

impl Ini

pub fn load_from_str(buf: &str) -> Result<Ini, ParseError>

Load from a string

pub fn load_from_str_noescape(buf: &str) -> Result<Ini, ParseError>

Load from a string, but do not interpret '' as an escape character

pub fn load_from_str_opt(buf: &str, opt: ParseOption) -> Result<Ini, ParseError>

Load from a string with options

pub fn read_from<R: Read>(reader: &mut R) -> Result<Ini, Error>

Load from a reader

pub fn read_from_noescape<R: Read>(reader: &mut R) -> Result<Ini, Error>

Load from a reader, but do not interpret '' as an escape character

pub fn read_from_opt<R: Read>(
    reader: &mut R,
    opt: ParseOption
) -> Result<Ini, Error>

Load from a reader with options

pub fn load_from_file<P: AsRef<Path>>(filename: P) -> Result<Ini, Error>

Load from a file

pub fn load_from_file_noescape<P: AsRef<Path>>(
    filename: P
) -> Result<Ini, Error>

Load from a file, but do not interpret '' as an escape character

pub fn load_from_file_opt<P: AsRef<Path>>(
    filename: P,
    opt: ParseOption
) -> Result<Ini, Error>

Load from a file with options

impl<'a> Ini

pub fn iter(&'a self) -> SectionIter<'a>

Immutable iterate though sections

pub fn mut_iter(&'a mut self) -> SectionIterMut<'a>

Mutable iterate though sections Deprecated! Use iter_mut instead!

pub fn iter_mut(&'a mut self) -> SectionIterMut<'a>

Mutable iterate though sections

Trait Implementations

impl Clone for Ini

pub fn clone(&self) -> Ini

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Ini

pub fn default() -> Ini

Returns the "default value" for a type.

impl<'q> Index<&'q str> for Ini

type Output = Properties

The returned type after indexing.

pub fn index<'a>(&'a self, index: &'q str) -> &'a Properties

Performs the indexing (container[index]) operation.

impl<S: Into<String>> Index<Option<S>> for Ini

type Output = Properties

The returned type after indexing.

pub fn index(&self, index: Option<S>) -> &Properties

Performs the indexing (container[index]) operation.

impl<'q> IndexMut<&'q str> for Ini

pub fn index_mut<'a>(&'a mut self, index: &'q str) -> &'a mut Properties

Performs the mutable indexing (container[index]) operation.

impl<S: Into<String>> IndexMut<Option<S>> for Ini

pub fn index_mut(&mut self, index: Option<S>) -> &mut Properties

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Ini

type Item = (Option<&'a str>, &'a Properties)

The type of the elements being iterated over.

type IntoIter = SectionIter<'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Ini

type Item = (Option<&'a str>, &'a mut Properties)

The type of the elements being iterated over.

type IntoIter = SectionIterMut<'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.