rkyv's Introduction

rkyv

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
ptr_meta, which rkyv uses for pointer manipulation

rkyv in action

use rkyv::{
    archived_value,
    de::deserializers::AllocDeserializer,
    ser::{
        serializers::WriteSerializer,
        Serializer,
    },
    Archive,
    Serialize,
    Deserialize,
};

#[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
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 serializer = WriteSerializer::new(Vec::new());
    let pos = serializer.serialize_value(&value).expect("failed to serialize value");
    let buf = serializer.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);

    let mut deserializer = AllocDeserializer;
    let deserialized = archived.deserialize(&mut deserializer).expect("failed to deserialize value");
    assert_eq!(deserialized, value);
}

Recommend Projects