115 lines
4.3 KiB
Markdown
115 lines
4.3 KiB
Markdown
# Serde   [![Build Status]][actions] [![Latest Version]][crates.io] [![serde msrv]][Rust 1.31] [![serde_derive msrv]][Rust 1.56]
|
|
|
|
[Build Status]: https://img.shields.io/github/actions/workflow/status/serde-rs/serde/ci.yml?branch=master
|
|
[actions]: https://github.com/serde-rs/serde/actions?query=branch%3Amaster
|
|
[Latest Version]: https://img.shields.io/crates/v/serde.svg
|
|
[crates.io]: https://crates.io/crates/serde
|
|
[serde msrv]: https://img.shields.io/crates/msrv/serde.svg?label=serde%20msrv&color=lightgray
|
|
[serde_derive msrv]: https://img.shields.io/crates/msrv/serde_derive.svg?label=serde_derive%20msrv&color=lightgray
|
|
[Rust 1.31]: https://blog.rust-lang.org/2018/12/06/Rust-1.31-and-rust-2018.html
|
|
[Rust 1.56]: https://blog.rust-lang.org/2021/10/21/Rust-1.56.0.html
|
|
|
|
**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/derive.html)
|
|
- [Examples](https://serde.rs/examples.html)
|
|
- [API documentation](https://docs.rs/serde)
|
|
- [Release notes](https://github.com/serde-rs/serde/releases)
|
|
|
|
## Serde in action
|
|
|
|
<details>
|
|
<summary>
|
|
Click to show Cargo.toml.
|
|
<a href="https://play.rust-lang.org/?edition=2018&gist=72755f28f99afc95e01d63174b28c1f5" target="_blank">Run this code in the playground.</a>
|
|
</summary>
|
|
|
|
```toml
|
|
[dependencies]
|
|
|
|
# The core APIs, including the Serialize and Deserialize traits. Always
|
|
# required when using Serde. The "derive" feature is only required when
|
|
# using #[derive(Serialize, Deserialize)] to make Serde work with structs
|
|
# and enums defined in your crate.
|
|
serde = { version = "1.0", features = ["derive"] }
|
|
|
|
# Each data format lives in its own crate; the sample code below uses JSON
|
|
# but you may be using a different one.
|
|
serde_json = "1.0"
|
|
```
|
|
|
|
</details>
|
|
<p></p>
|
|
|
|
```rust
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
#[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
|
|
|
|
Serde is one of the most widely used Rust libraries so any place that Rustaceans
|
|
congregate will be able to help you out. For chat, consider trying the
|
|
[#rust-questions] or [#rust-beginners] channels of the unofficial community
|
|
Discord (invite: <https://discord.gg/rust-lang-community>), the [#rust-usage] or
|
|
[#beginners] channels of the official Rust Project Discord (invite:
|
|
<https://discord.gg/rust-lang>), or the [#general][zulip] stream in Zulip. For
|
|
asynchronous, consider the [\[rust\] tag on StackOverflow][stackoverflow], the
|
|
[/r/rust] subreddit which has a pinned weekly easy questions post, or the Rust
|
|
[Discourse forum][discourse]. It's acceptable to file a support issue in this
|
|
repo but they tend not to get as many eyes as any of the above and may get
|
|
closed without a response after some time.
|
|
|
|
[#rust-questions]: https://discord.com/channels/273534239310479360/274215136414400513
|
|
[#rust-beginners]: https://discord.com/channels/273534239310479360/273541522815713281
|
|
[#rust-usage]: https://discord.com/channels/442252698964721669/443150878111694848
|
|
[#beginners]: https://discord.com/channels/442252698964721669/448238009733742612
|
|
[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/122651-general
|
|
[stackoverflow]: https://stackoverflow.com/questions/tagged/rust
|
|
[/r/rust]: https://www.reddit.com/r/rust
|
|
[discourse]: https://users.rust-lang.org
|
|
|
|
<br>
|
|
|
|
#### License
|
|
|
|
<sup>
|
|
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
|
|
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
|
|
</sup>
|
|
|
|
<br>
|
|
|
|
<sub>
|
|
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.
|
|
</sub>
|