musli-wire

为适合网络通信的Müsli稳定格式进行全面升级。

线编码完全稳定升级

• ✔ 如果字段用#[musli(default)]注解，则可以容忍缺少的字段。
• ✔ 可以跳过未知字段。

这意味着它适合作为线格式，因为数据模型可以在客户端之间独立发展。一旦一些客户端进行了升级，它们将开始发送未知字段，而未升级的客户端将被迫在升级期间跳过这些字段。

use musli::{Encode, Decode};

#[derive(Debug, PartialEq, Encode, Decode)]
struct Version1 {
    name: String,
}

#[derive(Debug, PartialEq, Encode, Decode)]
struct Version2 {
    name: String,
    #[musli(default)]
    age: Option<u32>,
}

let version2 = musli_wire::to_vec(&Version2 {
    name: String::from("Aristotle"),
    age: Some(62),
})?;

let version1: Version1 = musli_wire::decode(version2.as_slice())?;

assert_eq!(version1, Version1 {
    name: String::from("Aristotle"),
});

配置

要配置线格式的行为，您可以使用Encoding类型

use musli::{Encode, Decode};
use musli_utils::options::{self, Options, Integer};
use musli_wire::Encoding;

const OPTIONS: Options = options::new().with_integer(Integer::Fixed).build();
const CONFIG: Encoding<OPTIONS> = Encoding::new().with_options();

#[derive(Debug, PartialEq, Encode, Decode)]
struct Struct<'a> {
    name: &'a str,
    age: u32,
}

let mut out = Vec::new();

let expected = Struct {
    name: "Aristotle",
    age: 61,
};

CONFIG.encode(&mut out, &expected)?;
let actual = CONFIG.decode(&out[..])?;

assert_eq!(expected, actual);

实现细节

每个字段都使用单个字节标签进行前缀类型，这允许接收器确定应该跳过多少。

打包项是前缀长度编码的，并且具有有限的大小。其确切长度由MAX_INLINE_LEN定义，并且可以使用Encoding::with_max_pack进行修改。