2018-05-27 21:18:30 -05:00
|
|
|
<!-- Serde readme rendered on crates.io -->
|
|
|
|
|
|
|
|
**Serde is a framework for *ser*ializing and *de*serializing Rust data structures efficiently and generically.**
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
You may be looking for:
|
|
|
|
|
|
|
|
- [An overview of Serde](https://serde.rs/)
|
|
|
|
- [Data formats supported by Serde](https://serde.rs/#data-formats)
|
|
|
|
- [Setting up `#[derive(Serialize, Deserialize)]`](https://serde.rs/codegen.html)
|
|
|
|
- [Examples](https://serde.rs/examples.html)
|
|
|
|
- [API documentation](https://docs.serde.rs/serde/)
|
|
|
|
- [Release notes](https://github.com/serde-rs/serde/releases)
|
|
|
|
|
|
|
|
## Serde in action
|
|
|
|
|
|
|
|
```rust
|
|
|
|
#[macro_use]
|
|
|
|
extern crate serde_derive;
|
|
|
|
|
|
|
|
extern crate serde;
|
|
|
|
extern crate serde_json;
|
|
|
|
|
|
|
|
#[derive(Serialize, Deserialize, Debug)]
|
|
|
|
struct Point {
|
|
|
|
x: i32,
|
|
|
|
y: i32,
|
|
|
|
}
|
|
|
|
|
|
|
|
fn main() {
|
|
|
|
let point = Point { x: 1, y: 2 };
|
|
|
|
|
|
|
|
// Convert the Point to a JSON string.
|
|
|
|
let serialized = serde_json::to_string(&point).unwrap();
|
|
|
|
|
|
|
|
// Prints serialized = {"x":1,"y":2}
|
|
|
|
println!("serialized = {}", serialized);
|
|
|
|
|
|
|
|
// Convert the JSON string back to a Point.
|
|
|
|
let deserialized: Point = serde_json::from_str(&serialized).unwrap();
|
|
|
|
|
|
|
|
// Prints deserialized = Point { x: 1, y: 2 }
|
|
|
|
println!("deserialized = {:?}", deserialized);
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Getting help
|
|
|
|
|
2018-06-30 12:29:36 -05:00
|
|
|
Serde developers live in the #serde channel on [`irc.mozilla.org`][irc]. The
|
|
|
|
\#rust channel is also a good resource with generally faster response time but
|
|
|
|
less specific knowledge about Serde. If IRC is not your thing or you don't get a
|
|
|
|
good response, we are happy to respond to [GitHub issues][issues] as well.
|
|
|
|
|
|
|
|
[irc]: https://wiki.mozilla.org/IRC
|
2018-06-30 12:30:14 -05:00
|
|
|
[issues]: https://github.com/serde-rs/serde/issues/new/choose
|