Skip to content
This repository was archived by the owner on Mar 25, 2024. It is now read-only.

Commit 667bd47

Browse files
authored
Merge pull request #190 from dtolnay/doc
Add multi-doc examples
2 parents cfe758b + 52de1e0 commit 667bd47

3 files changed

Lines changed: 61 additions & 0 deletions

File tree

‎Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ serde = "1.0.69"
1717
yaml-rust = "0.4.5"
1818

1919
[dev-dependencies]
20+
anyhow = "1.0"
2021
indoc = "1.0"
2122
serde_derive = "1.0"
2223

‎src/de.rs‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,43 @@ use yaml_rust::parser::{Event as YamlEvent, MarkedEventReceiver, Parser};
1818
use yaml_rust::scanner::{Marker, TScalarStyle, TokenType};
1919

2020
/// A structure that deserializes YAML into Rust values.
21+
///
22+
/// # Examples
23+
///
24+
/// Deserializing a single document:
25+
///
26+
/// ```
27+
/// use anyhow::Result;
28+
/// use serde::Deserialize;
29+
/// use serde_yaml::Value;
30+
///
31+
/// fn main() -> Result<()> {
32+
/// let input = "---\nk: 107\n";
33+
/// let de = serde_yaml::Deserializer::from_str(input);
34+
/// let value = Value::deserialize(de)?;
35+
/// println!("{:?}", value);
36+
/// Ok(())
37+
/// }
38+
/// ```
39+
///
40+
/// Deserializing multi-doc YAML:
41+
///
42+
/// ```
43+
/// use anyhow::Result;
44+
/// use serde::Deserialize;
45+
/// use serde_yaml::Value;
46+
///
47+
/// fn main() -> Result<()> {
48+
/// let input = "---\nk: 107\n...\n---\nj: 106\n";
49+
///
50+
/// for document in serde_yaml::Deserializer::from_str(input) {
51+
/// let value = Value::deserialize(document)?;
52+
/// println!("{:?}", value);
53+
/// }
54+
///
55+
/// Ok(())
56+
/// }
57+
/// ```
2158
pub struct Deserializer<'a> {
2259
input: Input<'a>,
2360
}

‎src/ser.rs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,29 @@ use std::{fmt, io, num, str};
88
use yaml_rust::{yaml, Yaml, YamlEmitter};
99

1010
/// A structure for serializing Rust values into YAML.
11+
///
12+
/// # Example
13+
///
14+
/// ```
15+
/// use anyhow::Result;
16+
/// use serde::Serialize;
17+
/// use std::collections::BTreeMap;
18+
///
19+
/// fn main() -> Result<()> {
20+
/// let mut buffer = Vec::new();
21+
/// let mut ser = serde_yaml::Serializer::new(&mut buffer);
22+
///
23+
/// let mut object = BTreeMap::new();
24+
/// object.insert("k", 107);
25+
/// object.serialize(&mut ser)?;
26+
///
27+
/// object.insert("J", 74);
28+
/// object.serialize(&mut ser)?;
29+
///
30+
/// assert_eq!(buffer, b"---\nk: 107\n...\n---\nJ: 74\nk: 107\n");
31+
/// Ok(())
32+
/// }
33+
/// ```
1134
pub struct Serializer<W> {
1235
documents: usize,
1336
writer: W,

0 commit comments

Comments
 (0)