serde/README.md

62 lines
2.1 KiB
Markdown
Raw Normal View History

2016-08-18 01:01:48 -04:00
# Serde   [![Build Status](https://api.travis-ci.org/serde-rs/serde.svg?branch=master)](https://travis-ci.org/serde-rs/serde) [![Coverage Status](https://coveralls.io/repos/serde-rs/serde/badge.svg?branch=master&service=github)](https://coveralls.io/github/serde-rs/serde?branch=master) [![Latest Version](https://img.shields.io/crates/v/serde.svg)](https://crates.io/crates/serde) [![Clippy Linting Result](https://clippy.bashy.io/github/serde-rs/serde/master/badge.svg)](https://clippy.bashy.io/github/serde-rs/serde/master/log)
2014-09-07 01:30:58 -07:00
2016-08-18 01:01:48 -04:00
**Serde is a framework for *ser*ializing and *de*serializing Rust data structures efficiently and generically.**
2014-09-07 01:30:58 -07:00
2016-08-18 01:01:48 -04:00
---
2015-03-31 22:16:15 -07:00
2016-08-18 01:01:48 -04:00
You may be looking for:
2015-08-09 16:37:01 -07:00
2016-08-18 01:01:48 -04:00
- [An overview of Serde](http://serde.rs/)
- [Data formats supported by Serde](http://serde.rs/#data-formats)
- [Setting up `#[derive(Serialize, Deserialize)]`](http://serde.rs/codegen.html)
- [Examples](http://serde.rs/examples.html)
- [API documentation](http://docs.serde.rs/serde/)
2015-08-09 16:37:01 -07:00
2016-08-18 01:01:48 -04:00
## Serde in action
```rust
2016-08-18 01:01:48 -04:00
#![feature(plugin, custom_derive)]
#![plugin(serde_macros)]
extern crate serde_json;
#[derive(Serialize, Deserialize, Debug)]
struct Point {
x: i32,
y: i32,
}
fn main() {
let point = Point { x: 1, y: 2 };
2016-08-18 01:01:48 -04:00
// Convert the Point to a JSON string.
let serialized = serde_json::to_string(&point).unwrap();
2015-04-01 21:59:37 -07:00
2016-08-18 01:01:48 -04:00
// Prints serialized = {"x":1,"y":2}
println!("serialized = {}", serialized);
2016-08-18 01:01:48 -04:00
// Convert the JSON string back to a Point.
let deserialized: Point = serde_json::from_str(&serialized).unwrap();
2016-08-18 01:01:48 -04:00
// Prints deserialized = Point { x: 1, y: 2 }
println!("deserialized = {:?}", deserialized);
}
2015-03-31 22:16:15 -07:00
```
2016-08-18 01:01:48 -04:00
## License
2016-08-18 01:01:48 -04:00
Serde is licensed under either of
2016-08-18 01:01:48 -04:00
* 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)
2016-08-18 01:01:48 -04:00
at your option.
2016-08-18 01:01:48 -04:00
### Contribution
2016-08-18 01:01:48 -04:00
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Serde by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.