Struct rkyv::boxed::ArchivedBox

#[repr(transparent)]
pub struct ArchivedBox<T: ArchivePointee + ?Sized>(_);

An archived Box.

This is a thin wrapper around a RelPtr to the archived type.

Implementations

impl<T: ArchivePointee + ?Sized> ArchivedBox<T>

pub fn get(&self) -> &T

Returns a reference to the value of this archived box.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Returns a pinned mutable reference to the value of this archived box

pub unsafe fn resolve_from_ref<U: ArchiveUnsized<Archived = T> + ?Sized>(
    value: &U,
    pos: usize,
    resolver: BoxResolver<U::MetadataResolver>,
    out: *mut Self
)

Resolves an archived box from the given value and parameters.

Safety

• pos must be the position of out within the archive
• resolver must be the result of serializing value

pub fn serialize_from_ref<U, S>(
    value: &U,
    serializer: &mut S
) -> Result<BoxResolver<U::MetadataResolver>, S::Error> where
    U: SerializeUnsized<S, Archived = T> + ?Sized,
    S: Fallible + ?Sized, 

Serializes an archived box from the given value and serializer.

impl<T> ArchivedBox<[T]>

pub unsafe fn serialize_copy_from_slice<U, S>(
    slice: &[U],
    serializer: &mut S
) -> Result<BoxResolver<MetadataResolver<[U]>>, S::Error> where
    U: Serialize<S, Archived = T>,
    S: Serializer + ?Sized, 

Serializes an archived Box from a given slice by directly copying bytes.

Safety

The type being serialized must be copy-safe. Copy-safe types must be trivially copyable (have the same archived and unarchived representations) and contain no padding bytes. In situations where copying uninitialized bytes the output is acceptable, this function may be used with types that contain padding bytes.

Trait Implementations

impl<T: ArchivePointee + ?Sized> AsRef<T> for ArchivedBox<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ArchivePointee + ?Sized> Borrow<T> for ArchivedBox<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, C> CheckBytes<C> for ArchivedBox<T> where
    T: ArchivePointee + CheckBytes<C> + LayoutRaw + Pointee + ?Sized,
    C: ArchiveContext + ?Sized,
    T::ArchivedMetadata: CheckBytes<C>,
    C::Error: Error, 

type Error = OwnedPointerError<<<T as ArchivePointee>::ArchivedMetadata as CheckBytes<C>>::Error, <T as CheckBytes<C>>::Error, <C as Fallible>::Error>

The error that may result from checking the type.

unsafe fn check_bytes<'a>(
    value: *const Self,
    context: &mut C
) -> Result<&'a Self, Self::Error>

Checks whether the given pointer points to a valid value within the given context.

impl<T: ArchivePointee + ?Sized> Debug for ArchivedBox<T> where
    T::ArchivedMetadata: Debug, 

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

Formats the value using the given formatter.

impl<T: ArchivePointee + ?Sized> Deref for ArchivedBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, D> Deserialize<Box<T, Global>, D> for ArchivedBox<T::Archived> where
    T: ArchiveUnsized + ?Sized,
    T::Archived: DeserializeUnsized<T, D>,
    D: Fallible + ?Sized, 

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

Deserializes using the given deserializer

impl<F: Archive, D: Fallible + ?Sized> DeserializeWith<ArchivedBox<<F as Archive>::Archived>, F, D> for AsBox where
    F::Archived: Deserialize<F, D>, 

fn deserialize_with(
    field: &ArchivedBox<F::Archived>,
    deserializer: &mut D
) -> Result<F, D::Error>

Deserializes the field type F using the given deserializer.

impl<T, D> DeserializeWith<ArchivedBox<[<T as Archive>::Archived]>, Box<[T], Global>, D> for CopyOptimize where
    T: Archive,
    T::Archived: Deserialize<T, D>,
    D: Fallible + ?Sized, 

fn deserialize_with(
    field: &ArchivedBox<[T::Archived]>,
    _: &mut D
) -> Result<Box<[T]>, D::Error>

Deserializes the field type F using the given deserializer.

impl<T: ArchivePointee + Display + ?Sized> Display for ArchivedBox<T>

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

Formats the value using the given formatter.

impl<T: ArchivePointee + Hash + ?Sized> Hash for ArchivedBox<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: ArchivePointee + Ord + ?Sized> Ord for ArchivedBox<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: ArchivePointee + PartialEq<U> + ?Sized, U: ArchivePointee + ?Sized> PartialEq<ArchivedBox<U>> for ArchivedBox<T>

fn eq(&self, other: &ArchivedBox<U>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ArchivePointee + PartialEq<U> + ?Sized, U: ?Sized> PartialEq<Box<U, Global>> for ArchivedBox<T>

fn eq(&self, other: &Box<U>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ArchivePointee + PartialOrd + ?Sized> PartialOrd<ArchivedBox<T>> for ArchivedBox<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ArchivePointee + PartialOrd<U> + ?Sized, U: ?Sized> PartialOrd<Box<U, Global>> for ArchivedBox<T>

fn partial_cmp(&self, other: &Box<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ArchivePointee + ?Sized> Pointer for ArchivedBox<T>

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

Formats the value using the given formatter.

impl<T: ArchivePointee + Eq + ?Sized> Eq for ArchivedBox<T>