From 659bbfa570e68ae06a845db08853ae2109839ad2 Mon Sep 17 00:00:00 2001
From: Alex Crichton <alex@alexcrichton.com>
Date: Sun, 2 Oct 2016 23:26:51 -0700
Subject: [PATCH] Touch up the `decode` example

---
 examples/decode.rs | 61 ++++++++++++++++++++++++++++++++++++++++++++++
 examples/struct.rs | 51 --------------------------------------
 2 files changed, 61 insertions(+), 51 deletions(-)
 create mode 100644 examples/decode.rs
 delete mode 100644 examples/struct.rs

diff --git a/examples/decode.rs b/examples/decode.rs
new file mode 100644
index 0000000..9124596
--- /dev/null
+++ b/examples/decode.rs
@@ -0,0 +1,61 @@
+//! An example showing off the usage of `RustcDecodable` to automatically decode
+//! TOML into a Rust `struct`
+//!
+//! Note that this works similarly with `serde` as well.
+
+#![deny(warnings)]
+
+extern crate toml;
+extern crate rustc_serialize;
+
+/// This is what we're going to decode into. Each field is optional, meaning
+/// that it doesn't have to be present in TOML.
+#[derive(Debug, RustcDecodable)]
+struct Config {
+    global_string: Option<String>,
+    global_integer: Option<u64>,
+    server: Option<ServerConfig>,
+    peers: Option<Vec<PeerConfig>>,
+}
+
+/// Sub-structs are decoded from tables, so this will decode from the `[server]`
+/// table.
+///
+/// Again, each field is optional, meaning they don't have to be present.
+#[derive(Debug, RustcDecodable)]
+struct ServerConfig {
+    ip: Option<String>,
+    port: Option<u64>,
+}
+
+#[derive(Debug, RustcDecodable)]
+struct PeerConfig {
+    ip: Option<String>,
+    port: Option<u64>,
+}
+
+fn main() {
+    let toml_str = r#"
+        global_string = "test"
+        global_integer = 5
+
+        [server]
+        ip = "127.0.0.1"
+        port = 80
+
+        [[peers]]
+        ip = "127.0.0.1"
+        port = 8080
+
+        [[peers]]
+        ip = "127.0.0.1"
+    "#;
+
+    // Use the `decode_str` convenience here to decode a TOML string directly
+    // into the `Config` struct.
+    //
+    // Note that the errors reported here won't necessarily be the best, but you
+    // can get higher fidelity errors working with `toml::Parser` directly.
+    let decoded: Config = toml::decode_str(toml_str).unwrap();
+    println!("{:#?}", decoded);
+}
diff --git a/examples/struct.rs b/examples/struct.rs
deleted file mode 100644
index 52b2eb7..0000000
--- a/examples/struct.rs
+++ /dev/null
@@ -1,51 +0,0 @@
-#![deny(warnings)]
-extern crate toml;
-extern crate rustc_serialize;
-
-use rustc_serialize::Decodable;
-
-#[derive(Debug,RustcDecodable)]
-struct Config {
-    global_string: Option<String>,
-    global_integer: Option<u64>,
-    server: Option<ServerConfig>,
-    peers: Option<Vec<PeerConfig>>,
-}
-
-#[derive(Debug,RustcDecodable)]
-struct ServerConfig {
-    ip: Option<String>,
-    port: Option<u64>,
-}
-
-#[derive(Debug,RustcDecodable)]
-struct PeerConfig {
-    ip: Option<String>,
-    port: Option<u64>,
-}
-
-fn main() {
-    let toml_str = r#"
-            global_string = "test"
-            global_integer = 5
-
-            [server]
-            ip = "127.0.0.1"
-            port = 80
-
-            [[peers]]
-            ip = "127.0.0.1"
-            port = 8080
-
-            [[peers]]
-            ip = "127.0.0.1"
-            port = 8081
-        "#;
-
-    let toml = toml::Parser::new(&toml_str).parse().unwrap();
-
-    let mut decoder = toml::Decoder::new(toml::Value::Table(toml));
-    let decoded = Config::decode(&mut decoder).unwrap();
-
-    println!("{:?}", decoded);
-}