[go: up one dir, main page]

Serializer

rkyv::ser

Struct Serializer 

Source 
pub struct Serializer<W, A, S> {
    pub writer: W,
    pub allocator: A,
    pub sharing: S,
}
Expand description

A serializer built from composeable pieces.

Fields§

§writer: W

The writer of the serializer.

§allocator: A

The allocator of the serializer.

§sharing: S

The pointer sharing of the serializer.

Implementations§

Source§

impl<W, A, S> Serializer<W, A, S>

Source

pub fn new(writer: W, allocator: A, sharing: S) -> Self

Creates a new serializer from a writer, allocator, and pointer sharing.

Source

pub fn into_raw_parts(self) -> (W, A, S)

Consumes the serializer and returns the components.

Source

pub fn into_writer(self) -> W

Consumes the serializer and returns the writer.

The allocator and pointer sharing are discarded.

Trait Implementations§

Source§

impl<W, A: Allocator<E>, S, E> Allocator<E> for Serializer<W, A, S>

Source§

unsafe fn push_alloc(&mut self, layout: Layout) -> Result<NonNull<[u8]>, E>

Allocates scratch space of the requested size. Read more
Source§

unsafe fn pop_alloc( &mut self, ptr: NonNull<u8>, layout: Layout, ) -> Result<(), E>

Deallocates previously allocated scratch space. Read more
Source§

impl<W: Debug, A: Debug, S: Debug> Debug for Serializer<W, A, S>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<W: Default, A: Default, S: Default> Default for Serializer<W, A, S>

Source§

fn default() -> Serializer<W, A, S>

Returns the “default value” for a type. Read more
Source§

impl<W: Positional, A, S> Positional for Serializer<W, A, S>

Source§

fn pos(&self) -> usize

Returns the current position of the writer.
Source§

impl<W, A, S: Sharing<E>, E> Sharing<E> for Serializer<W, A, S>

Source§

fn start_sharing(&mut self, address: usize) -> SharingState

Starts sharing the value associated with the given address.
Source§

fn finish_sharing(&mut self, address: usize, pos: usize) -> Result<(), E>

Finishes sharing the value associated with the given address. Read more
Source§

impl<W: Writer<E>, A, S, E> Writer<E> for Serializer<W, A, S>

Source§

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

Attempts to write the given bytes to the serializer.

Auto Trait Implementations§

§

impl<W, A, S> Freeze for Serializer<W, A, S>
where W: Freeze, A: Freeze, S: Freeze,

§

impl<W, A, S> RefUnwindSafe for Serializer<W, A, S>
where W: RefUnwindSafe, A: RefUnwindSafe, S: RefUnwindSafe,

§

impl<W, A, S> Send for Serializer<W, A, S>
where W: Send, A: Send, S: Send,

§

impl<W, A, S> Sync for Serializer<W, A, S>
where W: Sync, A: Sync, S: Sync,

§

impl<W, A, S> Unpin for Serializer<W, A, S>
where W: Unpin, A: Unpin, S: Unpin,

§

impl<W, A, S> UnwindSafe for Serializer<W, A, S>
where W: UnwindSafe, A: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<S, E> SharingExt<E> for S
where S: Sharing<E> + ?Sized,

Source§

fn serialize_shared<T: SerializeUnsized<Self> + ?Sized>( &mut self, value: &T, ) -> Result<usize, <Self as Fallible>::Error>
where Self: Fallible<Error = E>, E: Source,

Serializes the given shared value and returns its position. If the value has already been serialized then it returns the position of the previously added value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, E> WriterExt<E> for T
where T: Writer<E> + ?Sized,

Source§

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

Advances the given number of bytes as padding.
Source§

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

Aligns the position of the serializer to the given alignment.
Source§

fn align_for<T>(&mut self) -> Result<usize, E>

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

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

Resolves the given value with its resolver and writes the archived type. Read more
Source§

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

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