Struct rkyv::rc::ArchivedRc

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

An archived Rc.

This is a thin wrapper around a RelPtr to the archived type paired with a “flavor” type. Because there may be many varieties of shared pointers and they may not be used together, the flavor helps check that memory is not being shared incorrectly during validation.

Implementations

impl<T: ArchivePointee + ?Sized, F> ArchivedRc<T, F>

pub fn get(&self) -> &T

Gets the value of the ArchivedRc.

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

Gets the pinned mutable value of this ArchivedRc.

Safety

Any other ArchivedRc pointers to the same value must not be dereferenced for the duration of the returned borrow.

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

Resolves an archived Rc from a given reference.

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: SerializeUnsized<S> + ?Sized, S: Serializer + SharedSerializeRegistry + ?Sized>(
    value: &U,
    serializer: &mut S
) -> Result<RcResolver<MetadataResolver<U>>, S::Error>

Serializes an archived Rc from a given reference.

Trait Implementations

impl<T: ArchivePointee + ?Sized, F> AsRef<T> for ArchivedRc<T, F>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: ArchivePointee + ?Sized, F> Borrow<T> for ArchivedRc<T, F>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized, F, C: ?Sized> CheckBytes<C> for ArchivedRc<T, F> where
    T: ArchivePointee + CheckBytes<C> + LayoutRaw + Pointee + 'static,
    C: ArchiveContext + SharedContext,
    T::ArchivedMetadata: CheckBytes<C>,
    C::Error: Error,
    F: 'static, 

type Error = SharedPointerError<<T::ArchivedMetadata as CheckBytes<C>>::Error, T::Error, C::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 + Debug + ?Sized, F> Debug for ArchivedRc<T, F>

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

Formats the value using the given formatter.

impl<T: ArchivePointee + ?Sized, F> Deref for ArchivedRc<T, F>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ArchiveUnsized + ?Sized + 'static, D: SharedDeserializeRegistry + ?Sized> Deserialize<Arc<T>, D> for ArchivedRc<T::Archived, ArcFlavor> where
    T::Archived: DeserializeUnsized<T, D>, 

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

Deserializes using the given deserializer

impl<T: ?Sized, D: ?Sized> Deserialize<Rc<T>, D> for ArchivedRc<T::Archived, RcFlavor> where
    T: ArchiveUnsized + 'static,
    T::Archived: DeserializeUnsized<T, D>,
    D: SharedDeserializeRegistry, 

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

Deserializes using the given deserializer

impl<T: ArchivePointee + Display + ?Sized, F> Display for ArchivedRc<T, F>

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

Formats the value using the given formatter.

impl<T: ArchivePointee + Hash + ?Sized, F> Hash for ArchivedRc<T, F>

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, F> Ord for ArchivedRc<T, F>

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: ?Sized, U> PartialEq<Arc<U>> for ArchivedRc<T, ArcFlavor> where
    T: ArchivePointee + PartialEq<U>,
    U: ?Sized, 

fn eq(&self, other: &Arc<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: ?Sized, TF, U: ?Sized, UF> PartialEq<ArchivedRc<U, UF>> for ArchivedRc<T, TF> where
    T: ArchivePointee + PartialEq<U>,
    U: ArchivePointee, 

fn eq(&self, other: &ArchivedRc<U, UF>) -> 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<Rc<U>> for ArchivedRc<T, RcFlavor>

fn eq(&self, other: &Rc<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: ?Sized, TF, U: ?Sized, UF> PartialOrd<ArchivedRc<U, UF>> for ArchivedRc<T, TF> where
    T: ArchivePointee + PartialOrd<U>,
    U: ArchivePointee, 

fn partial_cmp(&self, other: &ArchivedRc<U, UF>) -> 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, F> Pointer for ArchivedRc<T, F>

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

Formats the value using the given formatter.

impl<T: ArchivePointee + Eq + ?Sized, F> Eq for ArchivedRc<T, F>