Resources
Learning Materials
- The rkyv book covers the motivation, architecture, and major
features of rkyv
- The rkyv discord is a great place to get help with specific issues and meet
other people using rkyv
Documentation
Benchmarks
- The rust serialization benchmark is a
shootout style benchmark comparing many rust serialization solutions. It includes special
benchmarks for zero-copy serialization solutions like rkyv.
Sister Crates
- bytecheck, which rkyv uses for validation
- ptr_meta, which rkyv uses for pointer manipulation
- rend, which rkyv uses for endian-agnostic features
Example
use rkyv::{Archive, Deserialize, Serialize};
use bytecheck::CheckBytes;
#[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
#[archive(compare(PartialEq))]
#[archive_attr(derive(CheckBytes, Debug))]
struct Test {
int: u8,
string: String,
option: Option<Vec<i32>>,
}
let value = Test {
int: 42,
string: "hello world".to_string(),
option: Some(vec![1, 2, 3, 4]),
};
let bytes = rkyv::to_bytes::<_, 256>(&value).unwrap();
use rkyv::ser::{Serializer, serializers::AllocSerializer};
let mut serializer = AllocSerializer::<0>::default();
serializer.serialize_value(&value).unwrap();
let bytes = serializer.into_serializer().into_inner();
let archived = rkyv::check_archived_root::<Test>(&bytes[..]).unwrap();
assert_eq!(archived, &value);
let archived = unsafe { rkyv::archived_root::<Test>(&bytes[..]) };
assert_eq!(archived, &value);
let deserialized: Test = archived.deserialize(&mut rkyv::Infallible).unwrap();
assert_eq!(deserialized, value);