keyvalues-serde

keyvalues-serde 是一个基于 VDF 文本 v1 的 (反) 序列化库，构建在 serde 框架之上。该库利用 keyvalues-parser 进行解析和渲染 keyvalues 文本，使得使用强类型 Rust 结构处理 VDF 文本文件变得容易。

安装

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

[dependencies]
keyvalues-serde = "0.1.0"
serde = { version = "1.0.0", features = ["derive"] }

快速入门

use serde::Deserialize;

// Contents take from my ~/.data/Steam/steam/games/PlatformMenu.vdf
const VDF_TEXT: &str = r##"
// this file defines the contents of the platform menu
"Platform"
{
    "Menu"
    {
        "Games"
        {
            "dll"       "steamui"
            "interface" "SteamUIGames001"
            "MenuName"  "#Steam_Games"
            "SteamApp"  "1"
        }
        "Friends"
        {
            "dll"       "bin/friendsui"
            "interface" "VGuiModuleTracker001"
            "MenuName"  "#App_Friends"
        }
        "Servers"
        {
            "dll"       "bin/serverbrowser"
            "interface" "VGuiModuleServerBrowser001"
            "MenuName"  "#App_Servers"
        }
        "Settings"
        {
            "dll"       "steamui"
            "interface" "VGuiModuleSettings001"
            "MenuName"  "#App_Settings"
            "SteamApp"  "1"
        }
    }
}
"##;

#[derive(Deserialize, Debug)]
struct Platform {
    #[serde(rename = "Menu")]
    menu: Menu,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct Menu {
    games: MenuModule,
    friends: MenuModule,
    servers: MenuModule,
    settings: MenuModule,
}

#[derive(Deserialize, Debug)]
struct MenuModule {
    dll: String,
    interface: String,
    #[serde(rename = "MenuName")]
    menu_name: String,
    #[serde(rename = "SteamApp")]
    steam_app: Option<bool>,
}

fn main() -> keyvalues_serde::Result<()> {
    let platform: Platform = keyvalues_serde::from_str(VDF_TEXT)?;
    println!("{:#?}", platform);

    Ok(())
}

数据类型

支持

• 原始类型
  • bool
  • i8, i16, i32, i64, i128
  • u8, u16, u32, u64, u128
  • f32, f64
  • char
• String
• Option
  • VDF 没有null类型的概念，因此可选值如果存在则被视为 Some，如果不存在则被视为 None
• 单元变体枚举
  • 表示为与变体名称匹配的文本
• Newtype 结构体
  • 视为包含数据类型的包装器
• 同质序列（类似于 Vec 的类型）
  • 表示为具有相同键的多个键值对
• 异质序列（类似于 tuple 的类型）
  • 表示为具有相同键的多个键值对
• 元组结构体
  • 视为包含元组的包装器
• 映射（类似于 HashMap 的类型）
  • 表示为花括号 {} 内的键值对列表
• 结构体
  • 与映射相同。结构体的名称在顶层键使用时除外则被忽略