Struct rkyv::ArchiveBuffer

pub struct ArchiveBuffer<T> { /* fields omitted */ }

Wraps a byte buffer and writes into it.

Common uses include archiving in #[no_std] environments and archiving small objects without allocating.

Examples

use rkyv::{Aligned, Archive, ArchiveBuffer, Archived, WriteExt};

#[derive(Archive)]
enum Event {
    Spawn,
    Speak(String),
    Die,
}
 
fn main() {
    let mut writer = ArchiveBuffer::new(Aligned([0u8; 256]));
    let pos = writer.archive(&Event::Speak("Help me!".to_string()))
        .expect("failed to archive event");
    let buf = writer.into_inner();
    let archived = unsafe { &*buf.as_ref().as_ptr().add(pos).cast::<Archived<Event>>() };
    if let Archived::<Event>::Speak(message) = archived {
        assert_eq!(message.as_str(), "Help me!");
    } else {
        panic!("archived event was of the wrong type");
    }
}

Implementations

impl<T> ArchiveBuffer<T>

pub fn new(inner: T) -> Self

Creates a new archive buffer from a byte buffer.

pub fn with_pos(inner: T, pos: usize) -> Self

Creates a new archive buffer from a byte buffer. The buffer will start writing at the given position, but the buffer must contain all bytes (otherwise the alignments of types may not be correct).

pub fn into_inner(self) -> T

Consumes the buffer and returns the internal buffer used to create it.

Trait Implementations

impl<T: AsRef<[u8]> + AsMut<[u8]>> Write for ArchiveBuffer<T>

type Error = ArchiveBufferError

The errors that may occur while writing.

fn pos(&self) -> usize

Returns the current position of the writer.

fn write(&mut self, bytes: &[u8]) -> Result<(), Self::Error>

Attempts to write the given bytes to the writer.