Rudano

Rudano，Rust 数据表示法，是一种旨在尽可能接近 Rust 自身语法的数据序列化格式。

为什么？

虽然我非常喜欢 RON，但我发现语法差异在频繁在它和 Rust 之间切换上下文时会使您感到困惑，特别是当 () 用于结构体时。

这就是我创建鲁达诺的原因，重点是使其与 Rust 的字面量表示法本身非常相似，这样您就可以使用您已经熟悉的相同语法来编写您的“对象”描述。

例外情况是映射，Rust 中没有字面量语法，并且选择使用 [] 来分隔。在 其规范 中解释了原因。

示例和比较

考虑以下虚构的 Rust 结构

#[derive(Serialize, Deserialize)]
enum Ip {
    V4(u8, u8, u8, u8),
    V6(u8, u8, u8, u8, u8, u8, u8, u8),
}

#[derive(Serialize, Deserialize)]
struct Network {
    name: String,
    local_address: Ip,
    hosts: HashMap<String, Ip>,
}

在鲁达诺中此结构的示例

// Struct name is required (see why below)
Network {
    name: "Local Network",
    // Enums are supported
    local_address: V4(192, 168, 0, 100),
    hosts: [
        "Foo": V6(0, 0, 0, 0, 0, 0, 0, 0xA3),
        "Bar": V4(192, 168, 0, 104),
    ], // Trailing comma is allowed
}

相同的 Ron 示例

// Struct name is optional
Network (
    name: "Local Network",
    // Enums are supported
    local_address: V4(192, 168, 0, 100),
    hosts: {
        "Foo": V6(0, 0, 0, 0, 0, 0, 0, 0xA3),
        "Bar": V4(192, 168, 0, 104),
    }, // Trailing comma is allowed
)

在 JSON 中，不允许注释，但我希望它不言自明

{
    "name": "Local Network",
    "local_address": {
        "V4": [192, 168, 0, 100]
    },
    "hosts": {
        "Foo": {
            "V6": [0, 0, 0, 0, 0, 0, 0, 0xA3]
        },
        "Bar": {
            "V4": [192, 168, 0, 104]
        }
    }
}

贡献

欢迎提出任何问题、错误报告、建议或拉取请求！只需打开一个问题或 PR。

稳定性

不稳定，该格式本身可能需要更改以解决歧义问题并更好地符合 Rust 的语法，使用 semver 进行破坏性更改。

注意事项

• 使用借用字符串进行零拷贝反序列化时，如果使用转义码，将失败。（我相信这同样适用于任何其他格式）

为什么需要结构体名称？

由于格式中需要结构体名称，因此可以在不破坏向后兼容性的情况下将结构体转换为枚举变体。例如，当使用

struct Point { position: (i32, i32), name: String }

enum Object {
    Point { position: (i32, i32), name: String },
    Canvas { size: (i32, i32) }
}

序列化值 Point 如下所示：Point { position: (10, 20), "Great Point!" } 既可以作为 Point 类型也可以作为 Object 类型。这对于所有结构体类型及其等效枚举变体（Unit, NewType, Tuple 和 Struct）都有效。

Rust 版本支持

最低支持版本（MSRV）为 1.40 或更高，并且已使用 1.40.0（稳定版）、beta 版和 nightly 版本进行测试。仅在对小版本（0.x）或更高版本进行更新时才会更改。

数据类型

注意，在所有带有定义的示例中，为了简洁，省略了 #[derive(Serialize, Deserialize)]。

布尔类型

布尔类型可以是字面量 true 或 false。

示例

• true
• false

有符号整数

有符号整数包括 i8, i16, i32, i64 和 i128。如果是负数，则开头为 -，如果是正数，则没有 +。数字中的下划线 _ 被忽略，并且可以使用前缀 0x，0o 或 0b 分别以十六进制、八进制或二进制形式书写。

示例

对于 i16

• 27
• 43
• 0x2A
• -0x1F
• 0b11010
• -37
• -32768
• 32767

无符号整数

无符号整数包括 u8, u16, u32, u64 和 u128。它们不支持 - 或 +。数字中的下划线 _ 被忽略，并且可以使用前缀 0x，0o 或 0b 分别以十六进制、八进制或二进制形式书写。

示例

对于 u16

• 27
• 43
• 0x2A
• 0b11010
• 0
• 65535

浮点数

浮点数类型包括 f32 和 f64，目前尚未完全指定。

示例

对于 f32

• 27
• 43.0
• 239.34
• -37.3
• -37.0E+12
• -92
• inf
• -inf

字符

字符类型由 '' 包围，并可以包含 参考中定义的任何字符或转义码。

struct Newtype(u8);

#[serde(transparent)]
struct Transparent(String);

struct TupleStruct(u8, char);

struct Point { position: (i32, i32), name: String }

enum Enum {
    Unit,
    Newtype(u32),
    Tuple(u32, u32),
    Struct {
        a: u32,
    },
}

struct Variants {
    unit: Enum,
    newtype: Enum,
    tuple: Enum,
    struct_variant: Enum,
}

Variants {
    unit: Unit,
    newtype: Newtype(70),
    tuple: Tuple(20, 80),
    struct_variant: Struct {
        a: 10,
    },
}