Struct rkyv::ser::serializers::BufferSerializer [−][src]
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, AlignedVec, 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>
[src]
impl<T> BufferSerializer<T>
[src]pub fn new(inner: T) -> Self
[src]
Creates a new archive buffer from a byte buffer.
pub fn with_pos(inner: T, pos: usize) -> Self
[src]
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
[src]
Consumes the serializer and returns the underlying type.
Trait Implementations
impl<T> Fallible for BufferSerializer<T>
[src]
impl<T> Fallible for BufferSerializer<T>
[src]type Error = BufferSerializerError
The error produced by any failing methods
impl<T: AsRef<[u8]> + AsMut<[u8]>> SeekSerializer for BufferSerializer<T>
[src]
impl<T: AsRef<[u8]> + AsMut<[u8]>> SeekSerializer for BufferSerializer<T>
[src]fn seek(&mut self, pos: usize) -> Result<(), Self::Error>
[src]
fn serialize_front<T: Serialize<Self>>(
&mut self,
value: &T
) -> Result<usize, Self::Error>
[src]
&mut self,
value: &T
) -> Result<usize, Self::Error>
fn serialize_unsized_front<T: SerializeUnsized<Self> + ?Sized>(
&mut self,
value: &T
) -> Result<usize, Self::Error> where
T::Metadata: Serialize<Self>,
T::Archived: ArchivePointee<ArchivedMetadata = Archived<T::Metadata>>,
[src]
&mut self,
value: &T
) -> Result<usize, Self::Error> where
T::Metadata: Serialize<Self>,
T::Archived: ArchivePointee<ArchivedMetadata = Archived<T::Metadata>>,
impl<T: AsRef<[u8]> + AsMut<[u8]>> Serializer for BufferSerializer<T>
[src]
impl<T: AsRef<[u8]> + AsMut<[u8]>> Serializer for BufferSerializer<T>
[src]fn pos(&self) -> usize
[src]
fn write(&mut self, bytes: &[u8]) -> Result<(), Self::Error>
[src]
fn pad(&mut self, padding: usize) -> Result<(), Self::Error>
[src]
fn align(&mut self, align: usize) -> Result<usize, Self::Error>
[src]
fn align_for<T>(&mut self) -> Result<usize, Self::Error>
[src]
unsafe fn resolve_aligned<T: Archive + ?Sized>(
&mut self,
value: &T,
resolver: T::Resolver
) -> Result<usize, Self::Error>
[src]
&mut self,
value: &T,
resolver: T::Resolver
) -> Result<usize, Self::Error>
fn serialize_value<T: Serialize<Self>>(
&mut self,
value: &T
) -> Result<usize, Self::Error>
[src]
&mut self,
value: &T
) -> 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>
[src]
&mut self,
value: &T,
to: usize,
metadata_resolver: T::MetadataResolver
) -> Result<usize, Self::Error>
fn serialize_unsized_value<T: SerializeUnsized<Self> + ?Sized>(
&mut self,
value: &T
) -> Result<usize, Self::Error>
[src]
&mut self,
value: &T
) -> Result<usize, Self::Error>
Auto Trait Implementations
impl<T> RefUnwindSafe for BufferSerializer<T> where
T: RefUnwindSafe,
impl<T> RefUnwindSafe for BufferSerializer<T> where
T: RefUnwindSafe,
impl<T> Send for BufferSerializer<T> where
T: Send,
impl<T> Send for BufferSerializer<T> where
T: Send,
impl<T> Sync for BufferSerializer<T> where
T: Sync,
impl<T> Sync for BufferSerializer<T> where
T: Sync,
impl<T> Unpin for BufferSerializer<T> where
T: Unpin,
impl<T> Unpin for BufferSerializer<T> where
T: Unpin,
impl<T> UnwindSafe for BufferSerializer<T> where
T: UnwindSafe,
impl<T> UnwindSafe for BufferSerializer<T> where
T: UnwindSafe,
Blanket Implementations
impl<T> ArchivePointee for T
[src]
impl<T> ArchivePointee for T
[src]type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
pub fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
[src]
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata