This crate is a Rust library for using the Serde serialization framework with data in YAML file format.
This library does not reimplement a YAML parser; it uses yaml-rust which is a pure Rust YAML 1.2 implementation.
[dependencies]
serde = "1.0"
serde_yaml = "0.8"
Release notes are available under GitHub releases.
API documentation is available in rustdoc form but the general idea is:
extern crate serde_yaml;
use std::collections::BTreeMap;
fn main() {
// You have some type.
let mut map = BTreeMap::new();
map.insert("x".to_string(), 1.0);
map.insert("y".to_string(), 2.0);
// Serialize it to a YAML string.
let s = serde_yaml::to_string(&map).unwrap();
assert_eq!(s, "---\nx: 1\ny: 2");
// Deserialize it back to a Rust type.
let deserialized_map: BTreeMap<String, f64> = serde_yaml::from_str(&s).unwrap();
assert_eq!(map, deserialized_map);
}
It can also be used with Serde's serialization code generator serde_derive
to
handle structs and enums defined in your own program.
[dependencies]
serde = "1.0"
serde_derive = "1.0"
serde_yaml = "0.8"
#[macro_use]
extern crate serde_derive;
extern crate serde_yaml;
#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct Point {
x: f64,
y: f64,
}
fn main() {
let point = Point { x: 1.0, y: 2.0 };
let s = serde_yaml::to_string(&point).unwrap();
assert_eq!(s, "---\nx: 1\ny: 2");
let deserialized_point: Point = serde_yaml::from_str(&s).unwrap();
assert_eq!(point, deserialized_point);
}
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Serde YAML by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.