序列化

序列化是一种为定义二进制文件格式而设计的序列化描述语言。与其他序列化工具（如Protocol Buffers）不同，序列化的序列化数据不具备向前或向后兼容性。相反，通过老版本格式的转换变得简单，允许数据更加紧凑，并能够更好地控制数据的底层形状。

目标

序列化有以下主要目标。

• 将文件格式的最大控制权交给用户
• 以语言无关的方式定义格式
• 支持从老版本格式轻松转换

其他较低级别的目标。

• 支持大整数类型
• 可以在其他语言中嵌入，而无需使用本地二进制文件

类型

以下类型受到支持。

结构体

使用多个 版本 定义 struct 类型。每个版本定义一系列字段。

struct Rectangle {
    version 1 {
        width: u32;
        height: u32;
    }
}

枚举

使用多个 版本 定义 enum 类型。每个版本定义一系列用作情况的字段。枚举值由这些字段之一精确组成。

struct StringOrInt {
    version 1 {
        str: string;
        num: int;
    }
}

外部类型

外部类型在用户代码中定义。类型定义、转换和编解码器必须在目标语言中实现。

外部类型可以声明可用于该类型的字面量。

extern MyString {
    literal {
        string;
    }
}

以下字面量规范受到支持。

运行时库类型

运行时库提供了许多 extern 类型。

int 和 nat 的编码定义了按小端顺序排列的位序列。如果每个字节中的最高位被设置，则意味着在该数字中有更多的字节。

此编码是字节序列 [B₀, ..., B_n]，其中当 i < n 时，B_i,7 = 1，并且 B_n,7 = 0。此字节序列相当于位序列 [B_0,0, ... B_0,6, ..., B_n-1,0, ..., B_n-1,6] = [b₀, ..., b_m-1]，其中 m = 6n。本质上，位序列去除了用于确定序列何时结束的标志位，并将每个字节的剩余位按从低到高的顺序排列。位序列映射如下

• 对于 int 类型，如果 b_m-1 = 0，则 k = b₀ * 2⁰ + ... + b_{m - 2} * 2^m-2
• 对于 int 类型，如果 b_m-1 = 1，则 k = -(b₀ * 2⁰ + ... + b_{m - 2} * 2^m-2) - 1
• 对于 nat 类型，k = b₀ * 2⁰ + ... + b_{m - 1} * 2^m-1

版本控制

在以下示例中，用户有一个用户名和出生日期。

struct Person {
    version 1 {
        name: Name;
        dob: Date;
    }
}

struct Name {
    version 1 {
        firstName: string;
        middleName: option string;
        lastName: string;
    }
}

但是，并非每个人都有 2 或 3 个名字。为了适应这种情况，我们可以创建一个新的版本，允许任意数量的名字。

struct Name {
    version 1 {
        ...
    }
    version 2 {
        names: list string;
    }
}

对 Name 的此更改意味着在格式的第 2 版中，Person 的 name 字段现在将使用 Name 的第 2 版。然而，由于没有对 Person 的直接更改，版本 2 将自动创建。在生成的代码中，预期用户将提供将 Name 从版本 1 升级到版本 2 的代码。但是，无需为升级 Person 提供此类代码。Person 可以通过其字段的升级代码自动升级。

最终

可以声明版本化类型为 final，以表示不会添加该类型的任何新版本。这限制了类型到最后显式声明的版本，防止自动生成新版本。最终类型可能仅包括最终或非版本化类型的字段。

final struct FormatVersion {
    version 1 {
        major: nat;
    }
}

泛型

泛型类型允许对类型进行参数化。

final struct Pair(A, B) {
    version 1 {
        left: A;
        right: B;
    }
}

常量

常量允许定义在所有生成的语言之间共享的值。

命令行

Verilization 具有命令行界面。以下选项被支持。

语言生成器

以下语言被支持。

• TypeScript
• Java
• Scala

编译器绑定

verilization 编译器是用 Rust 编写的。它可以编译成 WebAssembly 以在其他语言中使用。这有一个优点，即工具可以分发（例如，作为 NPM 包、独立 JAR 等），而无需任何本地二进制文件。这些绑定公开了一个可以直接从运行时使用的接口，以及一个仅依赖于相关运行时的命令行界面。

目前，以下运行时有绑定。

• Node