只有当 Formula 也是枚举时，才能为枚举推导出 Serialize。可序列化的枚举可以省略 Formula 中的某些（或所有）变体。它不能缺少 Formula 中的变体。每个变体随后遵循结构体的规则。

为了方便起见，Infallible 为枚举公式实现了 Serialize。

反序列化

Deserialize<'de, Formula> trait 用于根据特定公式实现反序列化。反序列化从字节数组读取并构建反序列化值。反序列化 不应该 执行除了构建和初始化反序列化值所需的动态分配以外的任何动态分配。例如，如果反序列化出非零数量的 T 值时，可以分配 Vec<T>，但它 不应该 过度分配。

类似于 Serialize，alkahest 提供了多个现成的 Deserialize trait 实现。可以使用原始公式 T 反序列化 From<T> 类型。

可以使用公式 F 反序列化的值也可以使用 Ref<F> 进行反序列化，它读取地址和长度，然后继续使用公式 F。

Vec<T> 可以使用切片公式进行反序列化。为实现了 Iterator 并懒加载反序列化 T: Deserialize<'de, F> 类型元素的 alkahest::SliceIter<'de, T> 类型实现了 Deserialize<'de, [F]>。 SliceIter 是可克隆的，可以从两端迭代，并且可以在常数时间内跳过元素。为了方便起见，SliceIter 还可以与数组公式进行反序列化。

为类型推导 Deserialize 将生成 Deserialize 实现，公式在属性 #[alkahest(FormulaRef)] 或 #[alkahest(deserialize(FormulaRef))] 中指定。通常，FormulaRef 是一个类型。当使用泛型时，它还包含泛型参数和界限。如果未指定公式，则假定 Self。还应该为类型推导 Formula。不建议为具有手动 Formula 实现的公式推导 Deserialize，因为 Deserialize 推导宏生成的代码使用由 Formula 推导宏生成的非公共项。因此，两者都应该有手动实现或都进行推导。

与 serde 的互操作性

Alkahest 非常酷，但几乎到处都在使用 serde，这也有很好的理由。在设计 Formula 时，可能希望包含支持序列化的现有类型 serde，尤其是如果它来自另一个包。这个包提供了 Bincode 和 Bincoded<T> 公式来覆盖这一点。任何实现了 serde::Serialize 的东西都可以使用 Bincode 公式进行序列化，当然它将使用 bincode 包进行序列化。Bincoded<T> 是 Bincode 的一个受限版本，只适用于 T。

使用示例

// This requires two default features - "alloc" and "derive".
#[cfg(all(feature = "derive", feature = "alloc"))]
fn main() {
  use alkahest::{alkahest, serialize_to_vec, deserialize};

  // Define simple formula. Make it self-serializable.
  #[derive(Clone, Debug, PartialEq, Eq)]
  #[alkahest(Formula, SerializeRef, Deserialize)]
  struct MyDataType {
    a: u32,
    b: Vec<u8>,
  }

  // Prepare data to serialize.
  let value = MyDataType {
    a: 1,
    b: vec![2, 3],
  };

  // Use infallible serialization to `Vec`.
  let mut data = Vec::new();

  // Note that this value can be serialized by reference.
  // This is default behavior for `Serialized` derive macro.
  // Some types required ownership transfer for serialization.
  // Notable example is iterators.
  let (size, _) = serialize_to_vec::<MyDataType, _>(&value, &mut data);

  let de = deserialize::<MyDataType, MyDataType>(&data[..size]).unwrap();
  assert_eq!(de, value);
}

#[cfg(not(all(feature = "derive", feature = "alloc")))]
fn main() {}

基准测试

Alkahest 包含了一个基准测试来与其他流行的序列化包进行比较。只需运行 cargo bench --all-features 就可以看到结果。

许可证

许可方式为以下之一

• Apache 许可证，版本 2.0，(license/APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT 许可证 (license/MIT 或 https://open-source.org.cn/licenses/MIT)

由您选择。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义，您提交的任何有意包含在作品中的贡献，都应如上所述双重许可，而不附加任何其他条款或条件。