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: ?Sized, S: ?Sized>(
    value: &U,
    serializer: &mut S
) -> Result<BoxResolver<U::MetadataResolver>, S::Error> where
    U: SerializeUnsized<S, Archived = T>,
    S: Fallible, 

Serializes an archived box from the given value and serializer.

Trait Implementations

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

fn as_ref(&self) -> &T

Performs the conversion.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

type Error = CheckOwnedPointerError<T, C>

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: ?Sized, D: ?Sized> Deserialize<Box<T, Global>, D> for ArchivedBox<T::Archived> where
    T: ArchiveUnsized,
    T::Archived: DeserializeUnsized<T, D>,
    D: Fallible, 

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

Deserializes 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 + 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>