33 releases

0.8.9 May 2, 2019
0.8.8 Dec 1, 2018
0.8.7 Oct 28, 2018
0.7.5 Jun 11, 2018
0.2.3 Mar 10, 2016

#8 in Encoding

Download history 14506/week @ 2019-02-17 17951/week @ 2019-02-24 16862/week @ 2019-03-03 17385/week @ 2019-03-10 19758/week @ 2019-03-17 15895/week @ 2019-03-24 29540/week @ 2019-03-31 37754/week @ 2019-04-07 22647/week @ 2019-04-14 42847/week @ 2019-04-21 39772/week @ 2019-04-28 25999/week @ 2019-05-05 47015/week @ 2019-05-12 47804/week @ 2019-05-19 54862/week @ 2019-05-26

145,745 downloads per month
Used in 297 crates (229 directly)

MIT/Apache

139KB
3K SLoC

Serde YAML

Build Status Latest Version Rust Documentation

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.

Dependency

[dependencies]
serde = "1.0"
serde_yaml = "0.8"

Release notes are available under GitHub releases.

Using Serde YAML

API documentation is available in rustdoc form but the general idea is:

use std::collections::BTreeMap;

fn main() -> Result<(), serde_yaml::Error> {
    // 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)?;
    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)?;
    assert_eq!(map, deserialized_map);
    Ok(())
}

It can also be used with Serde's derive macros to handle structs and enums defined by your program.

[dependencies]
serde = { version = "1.0", features = ["derive"] }
serde_yaml = "0.8"
use serde::{Serialize, Deserialize};

#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct Point {
    x: f64,
    y: f64,
}

fn main() -> Result<(), serde_yaml::Error> {
    let point = Point { x: 1.0, y: 2.0 };

    let s = serde_yaml::to_string(&point)?;
    assert_eq!(s, "---\nx: 1\ny: 2");

    let deserialized_point: Point = serde_yaml::from_str(&s)?;
    assert_eq!(point, deserialized_point);
    Ok(())
}

License

Licensed under either of

at your option.

Contribution

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.

Dependencies

~521KB
~12K SLoC