summaryrefslogtreecommitdiffstats
path: root/third_party/rust/rust-ini/README.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /third_party/rust/rust-ini/README.rst
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/rust-ini/README.rst')
-rw-r--r--third_party/rust/rust-ini/README.rst109
1 files changed, 109 insertions, 0 deletions
diff --git a/third_party/rust/rust-ini/README.rst b/third_party/rust/rust-ini/README.rst
new file mode 100644
index 0000000000..4189156b45
--- /dev/null
+++ b/third_party/rust/rust-ini/README.rst
@@ -0,0 +1,109 @@
+INI in Rust
+-----------
+
+.. image:: https://travis-ci.org/zonyitoo/rust-ini.svg?branch=master
+ :target: https://travis-ci.org/zonyitoo/rust-ini
+
+.. image:: https://img.shields.io/crates/v/rust-ini.svg
+ :target: https://crates.io/crates/rust-ini
+
+INI_ is an informal standard for configuration files for some platforms or software. INI files are simple text files with a basic structure composed of "sections" and "properties".
+
+.. _INI: http://en.wikipedia.org/wiki/INI_file
+
+This is an INI file parser in Rust_.
+
+.. _Rust: http://www.rust-lang.org/
+
+.. code:: toml
+
+ [dependencies]
+ rust-ini = "0.10"
+
+Usage
+=====
+
+* Create a Ini configuration file.
+
+.. code:: rust
+
+ extern crate ini;
+ use ini::Ini;
+
+ fn main() {
+ let mut conf = Ini::new();
+ conf.with_section(None)
+ .set("encoding", "utf-8");
+ conf.with_section(Some("User".to_owned()))
+ .set("given_name", "Tommy")
+ .set("family_name", "Green")
+ .set("unicode", "Raspberry树莓");
+ conf.with_section(Some("Book".to_owned()))
+ .set("name", "Rust cool");
+ conf.write_to_file("conf.ini").unwrap();
+ }
+
+Then you will get ``conf.ini``
+
+.. code:: ini
+
+ encoding=utf-8
+
+ [User]
+ given_name=Tommy
+ family_name=Green
+ unicode=Raspberry\x6811\x8393
+
+ [Book]
+ name=Rust cool
+
+* Read from file ``conf.ini``
+
+.. code:: rust
+
+ extern crate ini;
+ use ini::Ini;
+
+ fn main() {
+ let conf = Ini::load_from_file("conf.ini").unwrap();
+
+ let section = conf.section(Some("User".to_owned())).unwrap();
+ let tommy = section.get("given_name").unwrap();
+ let green = section.get("family_name").unwrap();
+
+ println!("{:?} {:?}", tommy, green);
+
+ // iterating
+ for (sec, prop) in &conf {
+ println!("Section: {:?}", sec);
+ for (key, value) in &prop {
+ println!("{:?}:{:?}", key, value);
+ }
+ }
+ }
+
+* More details could be found in `examples`.
+
+License
+=======
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Y. T. CHUNG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.