tag | 3c34ce8cb373cffc990cab9550e7d8200306bc82 | |
---|---|---|
tagger | The Android Open Source Project <initial-contribution@android.com> | Tue Apr 23 15:27:38 2024 -0700 |
object | 0003b54d2631e61df77dc6ade5ae2aec9515c6aa |
Platform Tools Release 35.0.1 (11580240)
commit | 0003b54d2631e61df77dc6ade5ae2aec9515c6aa | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Mar 07 02:17:27 2024 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Mar 07 02:17:27 2024 +0000 |
tree | 5508bbb6a64c0fd6f0054b6a574f59a19b8b0802 | |
parent | 552a6b4f269babd15ed842b14bafce4f284dfeea [diff] | |
parent | 70b6b6924fde4a926a49249fe4398369ff6264b3 [diff] |
Snap for 11541002 from 70b6b6924fde4a926a49249fe4398369ff6264b3 to sdk-release Change-Id: I0d094638e9b91b07ca6fe36da71a43ca2ba9ed3c
This crate is a Rust library for using the Serde serialization framework with data in YAML file format.
[dependencies] serde = "1.0" serde_yaml = "0.9"
Release notes are available under GitHub releases.
API documentation is available in rustdoc form but the general idea is:
use std::collections::BTreeMap; fn main() -> Result<(), serde_yaml::Error> { // You have some type. let mut map = BTreeMap::new(); map.insert("x".to_string(), 1.0); map.insert("y".to_string(), 2.0); // Serialize it to a YAML string. let yaml = serde_yaml::to_string(&map)?; assert_eq!(yaml, "x: 1.0\ny: 2.0\n"); // Deserialize it back to a Rust type. let deserialized_map: BTreeMap<String, f64> = serde_yaml::from_str(&yaml)?; assert_eq!(map, deserialized_map); Ok(()) }
It can also be used with Serde's derive macros to handle structs and enums defined in your program.
[dependencies] serde = { version = "1.0", features = ["derive"] } serde_yaml = "0.9"
Structs serialize in the obvious way:
use serde::{Serialize, Deserialize}; #[derive(Debug, PartialEq, Serialize, Deserialize)] struct Point { x: f64, y: f64, } fn main() -> Result<(), serde_yaml::Error> { let point = Point { x: 1.0, y: 2.0 }; let yaml = serde_yaml::to_string(&point)?; assert_eq!(yaml, "x: 1.0\ny: 2.0\n"); let deserialized_point: Point = serde_yaml::from_str(&yaml)?; assert_eq!(point, deserialized_point); Ok(()) }
Enums serialize using YAML's !tag
syntax to identify the variant name.
use serde::{Serialize, Deserialize}; #[derive(Serialize, Deserialize, PartialEq, Debug)] enum Enum { Unit, Newtype(usize), Tuple(usize, usize, usize), Struct { x: f64, y: f64 }, } fn main() -> Result<(), serde_yaml::Error> { let yaml = " - !Newtype 1 - !Tuple [0, 0, 0] - !Struct {x: 1.0, y: 2.0} "; let values: Vec<Enum> = serde_yaml::from_str(yaml).unwrap(); assert_eq!(values[0], Enum::Newtype(1)); assert_eq!(values[1], Enum::Tuple(0, 0, 0)); assert_eq!(values[2], Enum::Struct { x: 1.0, y: 2.0 }); // The last two in YAML's block style instead: let yaml = " - !Tuple - 0 - 0 - 0 - !Struct x: 1.0 y: 2.0 "; let values: Vec<Enum> = serde_yaml::from_str(yaml).unwrap(); assert_eq!(values[0], Enum::Tuple(0, 0, 0)); assert_eq!(values[1], Enum::Struct { x: 1.0, y: 2.0 }); // Variants with no data can be written using !Tag or just the string name. let yaml = " - Unit # serialization produces this one - !Unit "; let values: Vec<Enum> = serde_yaml::from_str(yaml).unwrap(); assert_eq!(values[0], Enum::Unit); assert_eq!(values[1], Enum::Unit); Ok(()) }