#messagepack #serialization #protocols #collection #derive #msgpacker

nightly no-std xxai-msgpacker

MessagePack 协议的 Rust 实现

2 个版本

0.4.4 2023年6月18日
0.4.3 2023年6月18日

#36 in #msgpack

每月22次下载
用于 3crates (直接使用2个)

MIT/Apache

80KB
2.5K SLoC

MessagePacker - 一个无 std 的 msgpack 实现

crates.io Documentation License

协议规范可以在这里找到。

这个库旨在实现简洁性和性能。不使用任何依赖,只使用标准 Rust 库。

它将为 Rust 原子类型实现 PackableUnpackable 特性。这些特性也可以手动实现。

功能

  • alloc: 实现了 VecString 的功能,并解锁自定义扩展。
  • derive: 启用 MsgPacker 便捷宏。
  • strict: 如果缓冲区大小违反了协议,将引发 panic;允许的最大大小为 u32::MAX
  • std: 为 std 集合实现 PackableUnpackable

示例

use msgpacker::prelude::*;
use std::collections::HashMap;

// boilerplate derives - those aren't required
#[derive(Debug, PartialEq, Eq)]
// this convenience derive macro will implement `Packable` and `Unpackable`
#[derive(MsgPacker)]
pub struct City {
    name: String,

    // The traits are implemented for stdlib collections. If you have a custom map, you can use the
    // directive `#[msgpacker(map)]` so the traits will be automatically implemented through the
    // iterators of the map.
    inhabitants_per_street: HashMap<String, u64>,

    // This is also automatically implemented. The manual implementation is via `#[msgpacker(array)]`.
    zones: Vec<String>,
}

// create an instance of a city.
let city = City {
    name: "Kuala Lumpur".to_string(),
    inhabitants_per_street: HashMap::from([
        ("Street 1".to_string(), 10),
        ("Street 2".to_string(), 20),
    ]),
    zones: vec!["Zone 1".to_string(), "Zone 2".to_string()],
};

// serialize the city into bytes
let mut buf = Vec::new();
let n = city.pack(&mut buf);
println!("serialized {} bytes", n);

// deserialize the city and assert correctness
let (n, deserialized) = City::unpack(&buf).unwrap();
println!("deserialized {} bytes", n);
assert_eq!(city, deserialized);

基准测试

使用 Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz 获得的测试结果。

实现的简洁性解锁了比 rmp-serde 高出 ~10x 的性能。

打包 1,000 个元素

image image

解包 1,000 个元素

image image

依赖

~115KB