rkyv 0.3.0

rkyv (archive) is a zero-copy deserialization framework for Rust.

API Documentation

• rkyv, the core library
• rkyv_dyn, which adds trait object support to rkyv
• rkyv_typename, a type naming library

Book

• The rkyv book covers the motivation and architecture of rkyv

Sister Crates:

• bytecheck, which rkyv uses for validation

rkyv in action

use rkyv::{Aligned, Archive, ArchiveBuffer, Archived, archived_value, Write};

#[derive(Archive)]
struct Test {
    int: u8,
    string: String,
    option: Option<Vec<i32>>,
}

fn main() {
    let value = Test {
        int: 42,
        string: "hello world".to_string(),
        option: Some(vec![1, 2, 3, 4]),
    };

    let mut writer = ArchiveBuffer::new(Aligned([0u8; 256]));
    let pos = writer.archive(&value).expect("failed to archive test");
    let buf = writer.into_inner();

    let archived = unsafe { archived_value::<Test>(buf.as_ref(), pos) };
    assert_eq!(archived.int, value.int);
    assert_eq!(archived.string, value.string);
    assert_eq!(archived.option, value.option);
}