[−][src]Trait rkyv::Archive
Writes a type to a Writer
so it can be used without
deserializing.
Archiving is done depth-first, writing any data owned by a type before
writing the data for the type itself. The Resolver
must be able
to create the archived type from only its own data and the value being
archived.
Examples
Most of the time, #[derive(Archive)]
will create an acceptable
implementation. You can use the #[archive(...)]
attribute to control how
the implementation is generated. See the Archive
derive
macro for more details.
use rkyv::{Aligned, Archive, ArchiveBuffer, Archived, archived_value, WriteExt}; #[derive(Archive)] struct Test { int: u8, string: String, option: Option<Vec<i32>>, } let mut writer = ArchiveBuffer::new(Aligned([0u8; 256])); let value = Test { int: 42, string: "hello world".to_string(), option: Some(vec![1, 2, 3, 4]), }; 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);
Many of the core and standard library types already have Archive
implementations available, but you may need to implement Archive
for your
own types in some cases the derive macro cannot handle.
In this example, we add our own wrapper that serializes a &'static str
as
if it's owned. Normally you can lean on the archived version of String
to
do most of the work, but this example does everything to demonstrate how to
implement Archive
for your own types.
use core::{slice, str}; use rkyv::{ Aligned, Archive, ArchiveBuffer, Archived, archived_value, offset_of, RelPtr, Resolve, Write, WriteExt, }; struct OwnedStr { inner: &'static str, } struct ArchivedOwnedStr { // This will be a relative pointer to the bytes of our string. ptr: RelPtr, // The length of the archived version must be explicitly sized for // 32/64-bit compatibility. Archive is not implemented for usize and // isize to help you avoid making this mistake. len: u32, } impl ArchivedOwnedStr { // This will help us get the bytes of our type as a str again. fn as_str(&self) -> &str { unsafe { // The as_ptr() function of RelPtr will get a pointer // to its memory. let bytes = slice::from_raw_parts(self.ptr.as_ptr(), self.len as usize); str::from_utf8_unchecked(bytes) } } } struct OwnedStrResolver { // This will be the position that the bytes of our string are stored at. // We'll use this to make the relative pointer of our ArchivedOwnedStr. bytes_pos: usize, } impl Resolve<OwnedStr> for OwnedStrResolver { // This is essentially the output type of the resolver. It must match // the Archived associated type in our impl of Archive for OwnedStr. type Archived = ArchivedOwnedStr; // The resolve function consumes the resolver and produces the archived // value at the given position. fn resolve(self, pos: usize, value: &OwnedStr) -> Self::Archived { Self::Archived { // We have to be careful to add the offset of the ptr field, // otherwise we'll be using the position of the ArchivedOwnedStr // instead of the position of the ptr. That's the reason why // RelPtr::new is unsafe. ptr: unsafe { RelPtr::new(pos + offset_of!(ArchivedOwnedStr, ptr), self.bytes_pos) }, len: value.inner.len() as u32, } } } impl Archive for OwnedStr { type Archived = ArchivedOwnedStr; /// This is the resolver we'll return from archive. type Resolver = OwnedStrResolver; fn archive<W: Write + ?Sized>(&self, writer: &mut W) -> Result<Self::Resolver, W::Error> { // This is where we want to write the bytes of our string and return // a resolver that knows where those bytes were written. let bytes_pos = writer.pos(); writer.write(self.inner.as_bytes())?; Ok(Self::Resolver { bytes_pos }) } } let mut writer = ArchiveBuffer::new(Aligned([0u8; 256])); const STR_VAL: &'static str = "I'm in an OwnedStr!"; let value = OwnedStr { inner: STR_VAL }; // It works! let pos = writer.archive(&value) .expect("failed to archive test"); let buf = writer.into_inner(); let archived = unsafe { archived_value::<OwnedStr>(buf.as_ref(), pos) }; // Let's make sure our data got written correctly assert_eq!(archived.as_str(), STR_VAL);
Associated Types
type Archived
[src]
The archived version of this type.
type Resolver: Resolve<Self, Archived = Self::Archived>
[src]
The resolver for this type. It must contain all the information needed to make the archived type from the unarchived type.
Required methods
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
Writes the dependencies for the object and returns a resolver that can create the archived type.
Implementations on Foreign Types
impl Archive for RangeFull
[src]
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: Archive> Archive for Range<T>
[src]
type Archived = ArchivedRange<T::Archived>
type Resolver = Range<T::Resolver>
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: Archive> Archive for RangeInclusive<T>
[src]
type Archived = ArchivedRangeInclusive<T::Archived>
type Resolver = Range<T::Resolver>
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for () where
(): Copy,
[src]
(): Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for bool where
bool: Copy,
[src]
bool: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for i8 where
i8: Copy,
[src]
i8: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for i16 where
i16: Copy,
[src]
i16: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for i32 where
i32: Copy,
[src]
i32: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for i64 where
i64: Copy,
[src]
i64: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for i128 where
i128: Copy,
[src]
i128: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for u8 where
u8: Copy,
[src]
u8: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for u16 where
u16: Copy,
[src]
u16: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for u32 where
u32: Copy,
[src]
u32: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for u64 where
u64: Copy,
[src]
u64: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for u128 where
u128: Copy,
[src]
u128: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for f32 where
f32: Copy,
[src]
f32: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for f64 where
f64: Copy,
[src]
f64: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for char where
char: Copy,
[src]
char: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroI8 where
NonZeroI8: Copy,
[src]
NonZeroI8: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroI16 where
NonZeroI16: Copy,
[src]
NonZeroI16: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroI32 where
NonZeroI32: Copy,
[src]
NonZeroI32: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroI64 where
NonZeroI64: Copy,
[src]
NonZeroI64: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroI128 where
NonZeroI128: Copy,
[src]
NonZeroI128: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroU8 where
NonZeroU8: Copy,
[src]
NonZeroU8: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroU16 where
NonZeroU16: Copy,
[src]
NonZeroU16: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroU32 where
NonZeroU32: Copy,
[src]
NonZeroU32: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroU64 where
NonZeroU64: Copy,
[src]
NonZeroU64: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for NonZeroU128 where
NonZeroU128: Copy,
[src]
NonZeroU128: Copy,
type Archived = Self
type Resolver = SelfResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicBool
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicI8
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicI16
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicI32
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicI64
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicU8
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicU16
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicU32
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for AtomicU64
[src]
type Archived = Self
type Resolver = AtomicResolver
pub fn archive<W: Write + ?Sized>(
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
_writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: Archive, const N: usize> Archive for [T; N]
[src]
type Archived = [T::Archived; N]
type Resolver = [T::Resolver; N]
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: Archive> Archive for Option<T>
[src]
type Archived = ArchivedOption<T::Archived>
type Resolver = Option<T::Resolver>
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<K: Archive + Hash + Eq, V: Archive> Archive for HashMap<K, V> where
K::Archived: Hash + Eq,
[src]
K::Archived: Hash + Eq,
type Archived = ArchivedHashMap<K::Archived, V::Archived>
type Resolver = ArchivedHashMapResolver
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<K: Archive + Hash + Eq> Archive for HashSet<K> where
K::Archived: Hash + Eq,
[src]
K::Archived: Hash + Eq,
type Archived = ArchivedHashSet<K::Archived>
type Resolver = ArchivedHashSetResolver
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl Archive for String
[src]
type Archived = ArchivedString
type Resolver = StringResolver
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: ArchiveRef + ?Sized> Archive for Box<T>
[src]
type Archived = ArchivedBox<Reference<T>>
type Resolver = BoxResolver<ReferenceResolver<T>>
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
impl<T: Archive> Archive for Vec<T>
[src]
type Archived = ArchivedVec<Reference<[T]>>
type Resolver = VecResolver<ReferenceResolver<[T]>>
pub fn archive<W: Write + ?Sized>(
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>
[src]
&self,
writer: &mut W
) -> Result<Self::Resolver, W::Error>