serde Documentation

Technical Documentation: serde-rs/serde

ℹ️ Provenance: Hybrid Fusion: serde-rs/serde (README + 1 In-Tree Chapters) · CodeWiki Reference · Recency: Active (< 180 days)

1. Project Overview & Quickstart (serde-rs/serde) Copy Chapter

Serde   [![Build Status]][actions] [![Latest Version]][crates.io] [![serde msrv]][Rust 1.56] [![serde_derive msrv]][Rust 1.71]

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

You may be looking for:

• An overview of Serde
• Data formats supported by Serde
• Setting up #[derive(Serialize, Deserialize)]
• Examples
• API documentation
• Release notes

Serde in action Copy Chapter

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::{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 Copy Chapter

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

2. In-Tree Documentation Chapters (serde-rs/serde) Copy Chapter

Serde   [![Build Status]][actions] [![Latest Version]][crates.io] [![serde msrv]][Rust 1.56] [![serde_derive msrv]][Rust 1.71]

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

You may be looking for:

• An overview of Serde
• Data formats supported by Serde
• Setting up #[derive(Serialize, Deserialize)]
• Examples
• API documentation
• Release notes

Serde in action Copy Chapter

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::{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 Copy Chapter

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

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~2161 tokens
• Recency Window: Active (< 180 days)
• Canonical Reference: https://codewiki.google/github.com/serde-rs/serde