vdf-serde

为 Valve 数据格式 提供对 Serde 的支持。

基于 steamy-vdf VDF 解析库。

使用方法

将以下内容添加到您的 Cargo.toml

[dependencies]
vdf-serde = "0.3.0"

简单示例

use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct Example {
    thing: String,
    other_thing: bool,
    more_stuff: Inner,
}

#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct Inner {
    bonus_content: u8,
    coolness: f64,
}

let vdf_data = "\"Example\"
{
\t\"thing\"\t\"hello\"
\t\"other_thing\"\t\"1\"
\t\"more_stuff\"
\t{
\t\t\"bonus_content\"\t\"69\"
\t\t\"coolness\"\t\"420.1337\"
\t}
}";
let data = Example {
    thing: "hello".to_string(),
    other_thing: true,
    more_stuff: Inner {
        bonus_content: 69,
        coolness: 420.1337,
    },
};

assert_eq!(vdf_serde::to_string(&data)?, vdf_data);
assert_eq!(vdf_serde::from_str::<Example>(vdf_data)?, data);

说明

由于 VDF 格式定义得相当不明确，因此在我找到一种兼容现有 VDF 文件的方法之前，以下来自 Serde 数据模型 的类型不受支持

• 字节数组
• 可选
• 单元 ()
• 单元结构 struct WillNotWork;
• 新类型变体 enum Broken { Example(u8) }
• 序列 Vec<T>
• 元组
• 元组结构 struct Unsupported(u8, bool, char);
• 元组变体 enum Bad { NotWorking(u8, bool, char) }
• 结构变体 enum Nope { NotHappening { datum: u8 } }

use std::collections::HashMap as Map;
use serde::{Serialize, Deserialize};
#[derive(Serialize, Deserialize, Debug, PartialEq)]
enum UnitVariants { A, B }
#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct NewtypeStruct(u8);
#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct KitchenSink {
    a: bool,
    b: i8,
    c: i16,
    d: i32,
    e: i64,
    f: u8,
    g: u16,
    h: u32,
    i: u64,
    j: f32,
    k: f64,
    l: char,
    m: String,
    n: UnitVariants,
    o: NewtypeStruct,
    p: Map<String, String>,
}

let data = KitchenSink { // yada yada yada
};
assert_eq!(data, vdf_serde::from_str(&vdf_serde::to_string(&data)?)?);