Struct rkyv::ser::serializers::ScratchTracker

source · [−]

pub struct ScratchTracker<T> { /* private fields */ }

Expand description

A passthrough scratch space allocator that tracks scratch space usage.

Implementations

source

impl<T> ScratchTracker<T>

source

pub fn new(inner: T) -> Self

Creates a new scratch tracker from the given inner scratch space.

source

pub fn max_bytes_allocated(&self) -> usize

Returns the maximum number of bytes that were concurrently allocated during serialization.

source

pub fn max_allocations(&self) -> usize

Returns the maximum number of concurrent allocations during serialization.

source

pub fn max_alignment(&self) -> usize

Returns the maximum alignment of scratch space requested during serialization.

source

pub fn min_buffer_size(&self) -> usize

Returns the minimum buffer size required to serialize the same data.

This calculation takes into account packing efficiency for slab allocated scratch space. It is not exact, and has an error bound of max_allocations * (max_alignment - 1) bytes. This should be suitably small for most use cases.

source

pub fn min_buffer_size_max_error(&self) -> usize

Returns the maximum error term for the minimum buffer size calculation.

Trait Implementations

source

impl<T: Debug> Debug for ScratchTracker<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T: Fallible> Fallible for ScratchTracker<T>

type Error = T::Error

The error produced by any failing methods.

source

impl<T> From<T> for ScratchTracker<T>

source

fn from(inner: T) -> Self

Performs the conversion.

source

impl<T: ScratchSpace> ScratchSpace for ScratchTracker<T>

source

unsafe fn push_scratch(
&mut self,
layout: Layout
) -> Result<NonNull<[u8 ]>, Self::Error>

Allocates scratch space of the requested size. Read more

source

unsafe fn pop_scratch(
 &mut self,
 ptr: NonNull<u8>,
 layout: Layout
) -> Result<(), Self::Error>

Deallocates previously allocated scratch space. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for ScratchTracker<T> where
T: RefUnwindSafe,

impl<T> Send for ScratchTracker<T> where
T: Send,

impl<T> Sync for ScratchTracker<T> where
T: Sync,

impl<T> Unpin for ScratchTracker<T> where
T: Unpin,

impl<T> UnwindSafe for ScratchTracker<T> where
T: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

source

fn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
 W: DeserializeWith<F, T, D>,
 D: Fallible + ?Sized,
 F: ?Sized,

source

fn deserialize(&self, deserializer: &mut D) -> Result<With<T, W>, D::Error>

Deserializes using the given deserializer

source

impl<T> From<!> for T

const: unstable · source

pub fn from(t: !) -> T

Performs the conversion.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rkyv::ser::serializers::ScratchTracker

Implementations

impl<T> ScratchTracker<T>

pub fn new(inner: T) -> Self

pub fn max_bytes_allocated(&self) -> usize

pub fn max_allocations(&self) -> usize

pub fn max_alignment(&self) -> usize

pub fn min_buffer_size(&self) -> usize

pub fn min_buffer_size_max_error(&self) -> usize

Trait Implementations

impl<T: Debug> Debug for ScratchTracker<T>

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

impl<T: Fallible> Fallible for ScratchTracker<T>

type Error = T::Error

impl<T> From<T> for ScratchTracker<T>

fn from(inner: T) -> Self

impl<T: ScratchSpace> ScratchSpace for ScratchTracker<T>

unsafe fn push_scratch( &mut self, layout: Layout) -> Result<NonNull<[u8]>, Self::Error>

unsafe fn pop_scratch( &mut self, ptr: NonNull<u8>, layout: Layout) -> Result<(), Self::Error>

Auto Trait Implementations

impl<T> RefUnwindSafe for ScratchTracker<T> where T: RefUnwindSafe,

impl<T> Send for ScratchTracker<T> where T: Send,

impl<T> Sync for ScratchTracker<T> where T: Sync,

impl<T> Unpin for ScratchTracker<T> where T: Unpin,

impl<T> UnwindSafe for ScratchTracker<T> where T: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata

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

pub fn borrow(&self) -> &T

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize(&self, deserializer: &mut D) -> Result<With<T, W>, D::Error>

impl<T> From<!> for T

pub fn from(t: !) -> T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointee for T

type Metadata = ()

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

type Error = Infallible

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

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

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

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

unsafe fn push_scratch(
&mut self,
layout: Layout
) -> Result<NonNull<[u8 ]>, Self::Error>

unsafe fn pop_scratch(
&mut self,
ptr: NonNull<u8>,
layout: Layout
) -> Result<(), Self::Error>

impl<T> RefUnwindSafe for ScratchTracker<T> where
T: RefUnwindSafe,

impl<T> Send for ScratchTracker<T> where
T: Send,

impl<T> Sync for ScratchTracker<T> where
T: Sync,

impl<T> Unpin for ScratchTracker<T> where
T: Unpin,

impl<T> UnwindSafe for ScratchTracker<T> where
T: UnwindSafe,

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

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

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

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,

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

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

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