Struct rkyv::ser::serializers::BufferSerializer

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

Wraps a byte buffer and equips it with Serializer.

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

Examples

use rkyv::{
    archived_value,
    ser::{Serializer, serializers::BufferSerializer},
    Aligned,
    Archive,
    Archived,
    Serialize,
};

#[derive(Archive, Serialize)]
enum Event {
    Spawn,
    Speak(String),
    Die,
}

let mut serializer = BufferSerializer::new(Aligned([0u8; 256]));
let pos = serializer.serialize_value(&Event::Speak("Help me!".to_string()))
    .expect("failed to archive event");
let buf = serializer.into_inner();
let archived = unsafe { archived_value::<Event>(buf.as_ref(), pos) };
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> BufferSerializer<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]>> Fallible for BufferSerializer<T>

type Error = BufferSerializerError

The error produced by any failing methods

impl<T: AsRef<[u8]> + AsMut<[u8]>> SeekSerializer for BufferSerializer<T>

fn seek(&mut self, pos: usize) -> Result<(), Self::Error>

Seeks the serializer to the given absolute position.

fn archive_root<T: Serialize<Self>>(
    &mut self,
    value: &T
) -> Result<usize, Self::Error>

Archives the given value at the nearest available position. If the serializer is already aligned, it will archive it at the current position.

fn archive_ref_root<T: SerializeUnsized<Self> + ?Sized>(
    &mut self,
    value: &T
) -> Result<usize, Self::Error> where
    T::Metadata: Serialize<Self>,
    T::Archived: ArchivePointee<ArchivedMetadata = Archived<T::Metadata>>, 

Archives a reference to the given value at the nearest available position. If the serializer is already aligned, it will archive it at the current position.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Serializer for BufferSerializer<T>

fn pos(&self) -> usize

Returns the current position of the serializer.

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

Attempts to write the given bytes to the serializer.

fn pad(&mut self, padding: usize) -> Result<(), Self::Error>

Advances the given number of bytes as padding.

fn align(&mut self, align: usize) -> Result<usize, Self::Error>

Aligns the position of the serializer to the given alignment.

fn align_for<T>(&mut self) -> Result<usize, Self::Error>

Aligns the position of the serializer to be suitable to write the given type.

unsafe fn resolve_aligned<T: Archive + ?Sized>(
    &mut self,
    value: &T,
    resolver: T::Resolver
) -> Result<usize, Self::Error>

Resolves the given value with its resolver and writes the archived type.

fn serialize_value<T: Serialize<Self>>(
    &mut self,
    value: &T
) -> Result<usize, Self::Error>

Archives the given object and returns the position it was archived at.

unsafe fn resolve_unsized_aligned<T: ArchiveUnsized + ?Sized>(
    &mut self,
    value: &T,
    to: usize,
    metadata_resolver: T::MetadataResolver
) -> Result<usize, Self::Error>

Resolves the given reference with its resolver and writes the archived reference.

fn serialize_unsized_value<T: SerializeUnsized<Self> + ?Sized>(
    &mut self,
    value: &T
) -> Result<usize, Self::Error>

Archives a reference to the given object and returns the position it was archived at.