Abomonation

一个令人痛苦的Rust序列化库

Abomonation（拼写有意为之）是一个基于非常简单想法的Rust序列化库：如果有人提供了要序列化的数据，它将复制那些确切的位，然后跟随任何指针并复制那些位，依此类推。在反序列化时恢复确切的位，然后更正指针以指向所跟踪数据的序列化形式。

警告：Abomonation不应用于任何您非常关心的数据，或来自任何您重视数据的计算机。encode 和 decode 方法执行可能导致未定义行为的事情，您不应容忍这种行为。具体来说，encode 将填充字节暴露给 memcpy，而 decode 并不十分尊重对齐。

有关更多信息，请参阅abomonation文档。

以下是一个使用Abomonation的示例。它非常容易使用。令人惊讶地容易。

extern crate abomonation;
use abomonation::{encode, decode};

// create some test data out of abomonation-approved types
let vector = (0..256u64).map(|i| (i, format!("{}", i))).collect();

// encode vector into a Vec<u8>
let mut bytes = Vec::new();
unsafe { encode(&vector, &mut bytes); }

// unsafely decode a &Vec<(u64, String)> from binary data (maybe your utf8 are lies!).
if let Some((result, remaining) = unsafe { decode::<Vec<(u64, String)>>(&mut bytes) } {
    assert!(result == &vector);
    assert!(remaining.len() == 0);
}

当您使用Abomonation时，事情可能会非常快。这是因为它所做的很少，主要是复制大量内存。键入

cargo bench

将触发Rust的基准测试基础设施（如果您不是使用nightly，则将发生错误。运气不好）。测试反复编码 Vec<u64>、Vec<String> 和 Vec<Vec<(u64, String)>>，得到如下数字：

test u64_enc        ... bench:         131 ns/iter (+/- 58) = 62717 MB/s
test string10_enc   ... bench:       8,784 ns/iter (+/- 2,791) = 3966 MB/s
test vec_u_s_enc    ... bench:       8,964 ns/iter (+/- 1,439) = 4886 MB/s

它们还反复解码相同的数据，得到如下数字：

test u64_dec        ... bench:           2 ns/iter (+/- 1) = 4108000 MB/s
test string10_dec   ... bench:       1,058 ns/iter (+/- 349) = 32930 MB/s
test vec_u_s_dec    ... bench:       1,232 ns/iter (+/- 223) = 35551 MB/s

这些吞吐量如此之高，因为要做的很少：内部指针需要更正，但在它们不存在的情况下（例如 u64），实际上没有任何事情要做。

#[macro_use]
extern crate abomonation;
use abomonation::{encode, decode};

#[derive(Eq, PartialEq)]
struct MyStruct {
    pub a: String,
    pub b: u64,
    pub c: Vec<u8>,
}

// (type : field1, field2 .. )
unsafe_abomonate!(MyStruct : a, b, c);

// create some test data out of abomonation-approved types
let record = MyStruct{ a: "test".to_owned(), b: 0, c: vec![0, 1, 2] };

// encode vector into a Vec<u8>
let mut bytes = Vec::new();
unsafe { encode(&record, &mut bytes); }

// decode a &Vec<(u64, String)> from binary data
if let Some((result, remaining)) = unsafe { decode::<MyStruct>(&mut bytes) } {
    assert!(result == &record);
    assert!(remaining.len() == 0);
}