Go to file
David Tolnay 7a8e4977e2
Merge pull request #2401 from dtolnay/docderive
Show derive macros in serde's rustdoc
2023-03-14 00:37:06 -07:00
.github Delete Emscripten CI 2023-01-27 19:47:13 -08:00
serde Enable serde derive feature when built by docs.rs 2023-03-14 00:33:41 -07:00
serde_derive Release 1.0.155 2023-03-11 12:57:53 -08:00
serde_derive_internals Ignore let_underscore_untyped pedantic clippy lint 2023-02-26 23:08:38 -07:00
serde_test Release 1.0.155 2023-03-11 12:57:53 -08:00
test_suite Treat field-level borrow attr as duplicate of variant-level borrow attr 2023-03-11 11:17:40 -08:00
.gitattributes Mark expandtest outputs as generated code 2022-06-20 03:27:20 -07:00
.gitignore Format in rfc style 2017-04-18 14:23:21 -07:00
Cargo.toml Workaround for "no bin target named serde_derive_tests_no_std" 2017-07-21 00:05:30 -07:00
CONTRIBUTING.md Fix outdated test instructions in CONTRIBUTING.md 2021-06-12 13:38:40 -07:00
crates-io.md Point documentation links to docs.rs instead of docs.serde.rs 2022-12-18 11:45:23 -08:00
LICENSE-APACHE Remove appendix from LICENSE-APACHE 2022-12-30 22:32:44 +03:00
LICENSE-MIT Copyright/license headers 2018-11-24 15:53:09 -08:00
README.md Update rust-version metadata and readme to match CI 2023-01-12 21:19:16 -08:00

Serde Build Status Latest Version serde: rustc 1.19+ serde_derive: rustc 1.31+

Serde is a framework for serializing and deserializing Rust data structures efficiently and generically.


You may be looking for:

Serde in action

Click to show Cargo.toml. Run this code in the playground.
[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"

use serde::{Serialize, Deserialize};

#[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 stream in Zulip. For asynchronous, consider the [rust] tag on StackOverflow, the /r/rust subreddit which has a pinned weekly easy questions post, or the Rust Discourse forum. 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.


License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
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.