serde_yaml 0.2.1

YAML support for Serde
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

Serde YAML Serialization Library
================================

[![Build Status](https://api.travis-ci.org/dtolnay/serde-yaml.svg?branch=master)](https://travis-ci.org/dtolnay/serde-yaml)
[![Latest Version](https://img.shields.io/crates/v/serde_yaml.svg)](https://crates.io/crates/serde_yaml)
[![Rust Documentation](https://img.shields.io/crates/v/serde_yaml.svg?label=rustdoc)](https://dtolnay.github.io/serde-yaml/serde_yaml/)

This crate is a Rust library for using the [Serde](https://github.com/serde-rs/serde)
serialization framework with data in [YAML](http://yaml.org) file format. This
library does not reimplement a YAML parser; it uses [yaml-rust](https://github.com/chyh1990/yaml-rust)
which is a pure Rust YAML 1.2 implementation.

Installation
============

Version 0.2.x of this crate works with 0.7.x of Serde. Both can be found on
[crates.io](https://crates.io/crates/serde_yaml) with a `Cargo.toml` like:

```toml
[dependencies]
serde = "^0.7"
serde_yaml = "^0.2"
```

Using Serde YAML
================

[API documentation is available in rustdoc form](https://dtolnay.github.io/serde-yaml/)
but the general idea is:

```rust
extern crate serde;
extern crate serde_yaml;

use std::collections::BTreeMap;

fn main() {
    let mut map = BTreeMap::new();
    map.insert("x".to_string(), 1.0);
    map.insert("y".to_string(), 2.0);

    let s = serde_yaml::to_string(&map).unwrap();
    assert_eq!(s, "---\n\"x\": 1\n\"y\": 2");

    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 automatic serialization library,
`serde_macros`. First add this to `Cargo.toml`:

```toml
[dependencies]
serde = "^0.7"
serde_macros = "^0.7"
serde_yaml = "^0.2"
```

Then use:

```rust
#![feature(plugin)]
#![plugin(serde_macros)]

extern crate serde;
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, "---\n\"x\": 1\n\"y\": 2");

    let deserialized_point: Point = serde_yaml::from_str(&s).unwrap();
    assert_eq!(point, deserialized_point);
}
```

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.