Struct rkyv::ser::serializers::BufferSerializer
source · [−]pub struct BufferSerializer<T> { /* private fields */ }
Expand description
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},
AlignedBytes,
AlignedVec,
Archive,
Archived,
Serialize,
};
#[derive(Archive, Serialize)]
enum Event {
Spawn,
Speak(String),
Die,
}
let mut serializer = BufferSerializer::new(AlignedBytes([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
sourceimpl<T> BufferSerializer<T>
impl<T> BufferSerializer<T>
sourcepub fn with_pos(inner: T, pos: usize) -> Self
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).
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Consumes the serializer and returns the underlying type.
Trait Implementations
sourceimpl<T: Debug> Debug for BufferSerializer<T>
impl<T: Debug> Debug for BufferSerializer<T>
sourceimpl<T: Default> Default for BufferSerializer<T>
impl<T: Default> Default for BufferSerializer<T>
sourceimpl<T> Fallible for BufferSerializer<T>
impl<T> Fallible for BufferSerializer<T>
type Error = BufferSerializerError
type Error = BufferSerializerError
The error produced by any failing methods.
sourceimpl<T: AsMut<[u8]>> Serializer for BufferSerializer<T>
impl<T: AsMut<[u8]>> Serializer for BufferSerializer<T>
sourcefn write(&mut self, bytes: &[u8]) -> Result<(), Self::Error>
fn write(&mut self, bytes: &[u8]) -> Result<(), Self::Error>
Attempts to write the given bytes to the serializer.
sourcefn pad(&mut self, padding: usize) -> Result<(), Self::Error>
fn pad(&mut self, padding: usize) -> Result<(), Self::Error>
Advances the given number of bytes as padding.
sourcefn align(&mut self, align: usize) -> Result<usize, Self::Error>
fn align(&mut self, align: usize) -> Result<usize, Self::Error>
Aligns the position of the serializer to the given alignment.
sourcefn align_for<T>(&mut self) -> Result<usize, Self::Error>
fn align_for<T>(&mut self) -> Result<usize, Self::Error>
Aligns the position of the serializer to be suitable to write the given type.
sourceunsafe fn resolve_aligned<T: Archive + ?Sized>(
&mut self,
value: &T,
resolver: T::Resolver
) -> Result<usize, Self::Error>
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. Read more
sourcefn serialize_value<T: Serialize<Self>>(
&mut self,
value: &T
) -> Result<usize, Self::Error>
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.
sourceunsafe fn resolve_unsized_aligned<T: ArchiveUnsized + ?Sized>(
&mut self,
value: &T,
to: usize,
metadata_resolver: T::MetadataResolver
) -> Result<usize, Self::Error>
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. Read more
sourcefn serialize_unsized_value<T: SerializeUnsized<Self> + ?Sized>(
&mut self,
value: &T
) -> Result<usize, Self::Error>
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.
Auto Trait Implementations
impl<T> RefUnwindSafe for BufferSerializer<T> where
T: RefUnwindSafe,
impl<T> Send for BufferSerializer<T> where
T: Send,
impl<T> Sync for BufferSerializer<T> where
T: Sync,
impl<T> Unpin for BufferSerializer<T> where
T: Unpin,
impl<T> UnwindSafe for BufferSerializer<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
sourcefn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata
fn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more