aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaphaƫl Huchet <rap2hpoutre@users.noreply.github.com>2017-05-10 17:39:19 +0200
committerGitHub <noreply@github.com>2017-05-10 17:39:19 +0200
commit85991c45c48ba380814cde02aae3a9e880a6613d (patch)
tree1b0f03946304c490b6819c09a188cb201a7dec1a
parentf94dc8d69b22f330e6be19882f2f02e09895f18f (diff)
downloadmilf-rs-85991c45c48ba380814cde02aae3a9e880a6613d.tar.gz
milf-rs-85991c45c48ba380814cde02aae3a9e880a6613d.zip
add example for to_string
-rw-r--r--src/ser.rs35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/ser.rs b/src/ser.rs
index 4896f8a..9af304f 100644
--- a/src/ser.rs
+++ b/src/ser.rs
@@ -50,6 +50,41 @@ pub fn to_vec<T: ?Sized>(value: &T) -> Result<Vec<u8>, Error>
/// Serialization can fail if `T`'s implementation of `Serialize` decides to
/// fail, if `T` contains a map with non-string keys, or if `T` attempts to
/// serialize an unsupported datatype such as an enum, tuple, or tuple struct.
+///
+/// # Examples
+///
+/// ```
+/// #[macro_use]
+/// extern crate serde_derive;
+/// extern crate toml;
+///
+/// #[derive(Serialize)]
+/// struct Config {
+/// database: Database,
+/// }
+///
+/// #[derive(Serialize)]
+/// struct Database {
+/// ip: String,
+/// port: Vec<u16>,
+/// connection_max: u32,
+/// enabled: bool,
+/// }
+///
+/// fn main() {
+/// let config = Config {
+/// database: Database {
+/// ip: "192.168.1.1".to_string(),
+/// port: vec![8001, 8002, 8003],
+/// connection_max: 5000,
+/// enabled: false,
+/// },
+/// };
+///
+/// let toml = toml::to_string(&config).unwrap();
+/// println!("{}", toml)
+/// }
+/// ```
pub fn to_string<T: ?Sized>(value: &T) -> Result<String, Error>
where T: ser::Serialize,
{