Function access

pub fn access<T, E>(bytes: &[u8]) -> Result<&T, E>
where
    T: Portable + for<'a> CheckBytes<HighValidator<'a, E>>,
    E: Source,

Available on crate features bytecheck and alloc only.

Access a byte slice.

This is a safe alternative to access_unchecked and is part of the high-level API.

Example

use rkyv::{
    access, bytecheck::CheckBytes, rancor::Error, to_bytes, Archive,
    Archived, Serialize,
};

#[derive(Archive, Serialize)]
struct Example {
    name: String,
    value: i32,
}

let value = Example {
    name: "pi".to_string(),
    value: 31415926,
};

let bytes = to_bytes::<Error>(&value).unwrap();
let archived = access::<ArchivedExample, Error>(&bytes).unwrap();

assert_eq!(archived.name, "pi");
assert_eq!(archived.value, 31415926);