Serde YAML

Rust库，用于使用Serde序列化框架处理YAML文件格式中的数据。此库仅遵循YAML规范1.1。。

此库是从serde-yaml的最新提交分叉而来，其提交编号为200950。^{[原始] [此项目]}我的目标是尽可能与David Tolnay的原始库兼容。

依赖

[dependencies]
serde = "1.0"
serde_yaml_ng = "0.9"

发布说明可在GitHub发布中找到。

使用Serde YAML

API文档以rustdoc形式提供，但基本思路是

use std::collections::BTreeMap;

fn main() -> Result<(), serde_yaml_ng::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_ng::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_ng::from_str(&yaml)?;
    assert_eq!(map, deserialized_map);
    Ok(())
}

它还可以与Serde的derive宏一起使用，以处理程序中定义的结构体和枚举。

[dependencies]
serde = { version = "1.0", features = ["derive"] }
serde_yaml_ng = "0.9"

结构体以直观的方式序列化

use serde::{Serialize, Deserialize};

#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct Point {
    x: f64,
    y: f64,
}

fn main() -> Result<(), serde_yaml_ng::Error> {
    let point = Point { x: 1.0, y: 2.0 };

    let yaml = serde_yaml_ng::to_string(&point)?;
    assert_eq!(yaml, "x: 1.0\ny: 2.0\n");

    let deserialized_point: Point = serde_yaml_ng::from_str(&yaml)?;
    assert_eq!(point, deserialized_point);
    Ok(())
}

枚举使用YAML的!tag语法来标识变体名称。

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_ng::Error> {
    let yaml = "
        - !Newtype 1
        - !Tuple [0, 0, 0]
        - !Struct {x: 1.0, y: 2.0}
    ";
    let values: Vec<Enum> = serde_yaml_ng::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_ng::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_ng::from_str(yaml).unwrap();
    assert_eq!(values[0], Enum::Unit);
    assert_eq!(values[1], Enum::Unit);

    Ok(())
}

为什么？

在项目开始时，我没有找到任何好的分叉。最佳候选者是serde_yml，它基于主要维护者的一个巨大的"初始提交"。这种做法会导致安全灾难。

我不想与人们就他们的做法争论，这就是为什么我为自己维护这个库，也为整个Rust生态系统维护它。就像我们法语说的："你永远不会比你自己更被服务得更好"。😉

使用它，不用它，我都不在乎。我会尽量修复尽可能多的错误。如果它们合理或容易处理，我会接受pull请求。

财务支持

我是个晚上在车库里工作，白天有高薪工作的人。我不需要你的钱。请！相反，给David Tolnay钱。这个人肩负着Rust生态系统的一半，在我分叉之前为这个项目写了大部分代码。我只是个跳上火车的人，不要给我任何钱。

许可证

本软件遵循MIT许可证。

任何贡献都必须附带开发者起源证书的签名，使用--signoff标志在git commit中。