Struct rkyv::rc::ArchivedRc

pub struct ArchivedRc<T: ArchivePointee + ?Sized, F> { /* private fields */ }

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_seal_unchecked(this: Seal<'_, Self>) -> Seal<'_, T>

Gets the sealed value of this ArchivedRc.

Safety

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

pub fn resolve_from_ref<U: ArchiveUnsized<Archived = T> + ?Sized>( value: &U, resolver: RcResolver, out: Place<Self>, )

Resolves an archived Rc from a given reference.

pub fn serialize_from_ref<U, S>( value: &U, serializer: &mut S, ) -> Result<RcResolver, S::Error>

where U: SerializeUnsized<S> + ?Sized, S: Fallible + Writer + Sharing + ?Sized, S::Error: Source,

Serializes an archived Rc from a given reference.

Trait Implementations

impl<T, F> AsRef<T> for ArchivedRc<T, F>

where T: ArchivePointee + ?Sized,

fn as_ref(&self) -> &T

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

impl<T, F> Borrow<T> for ArchivedRc<T, F>

where T: ArchivePointee + ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ArchivePointee + ?Sized, F, __C: Fallible + ?Sized> CheckBytes<__C> for ArchivedRc<T, F>

where <__C as Fallible>::Error: Trace, ArchivedRc<T, F>: Verify<__C>, RelPtr<T>: CheckBytes<__C>, PhantomData<F>: CheckBytes<__C>,

unsafe fn check_bytes( value: *const Self, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

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

impl<T, F> Debug for ArchivedRc<T, F>

where T: ArchivePointee + Debug + ?Sized,

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

Formats the value using the given formatter.

impl<T, F> Deref for ArchivedRc<T, F>

where T: ArchivePointee + ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, D> Deserialize<Arc<T>, D> for ArchivedRc<T::Archived, ArcFlavor>

where T: ArchiveUnsized + LayoutRaw + Pointee + ?Sized + 'static, T::Archived: DeserializeUnsized<T, D>, T::Metadata: Into<Metadata>, Metadata: Into<T::Metadata>, D: Fallible + Pooling + ?Sized, D::Error: Source,

Available on target_has_atomic="ptr" and crate feature alloc only.

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

Deserializes using the given deserializer

impl<T, D> Deserialize<Rc<T>, D> for ArchivedRc<T::Archived, RcFlavor>

where T: ArchiveUnsized + LayoutRaw + Pointee + ?Sized + 'static, T::Archived: DeserializeUnsized<T, D>, T::Metadata: Into<Metadata>, Metadata: Into<T::Metadata>, D: Fallible + Pooling + ?Sized, D::Error: Source,

Available on crate feature alloc only.

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

Deserializes using the given deserializer

impl<T, F> Display for ArchivedRc<T, F>

where T: ArchivePointee + Display + ?Sized,

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

Formats the value using the given formatter.

impl<T, F> Hash for ArchivedRc<T, F>

where T: ArchivePointee + Hash + ?Sized,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, F> Ord for ArchivedRc<T, F>

where T: ArchivePointee + Ord + ?Sized,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T, U> PartialEq<Arc<U>> for ArchivedRc<T, ArcFlavor>

where T: ArchivePointee + PartialEq<U> + ?Sized, U: ?Sized,

Available on target_has_atomic="ptr" and crate feature alloc only.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, TF, U, UF> PartialEq<ArchivedRc<U, UF>> for ArchivedRc<T, TF>

where T: ArchivePointee + PartialEq<U> + ?Sized, U: ArchivePointee + ?Sized,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U> PartialEq<Rc<U>> for ArchivedRc<T, RcFlavor>

where T: ArchivePointee + PartialEq<U> + ?Sized, U: ?Sized,

Available on crate feature alloc only.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, TF, U, UF> PartialOrd<ArchivedRc<U, UF>> for ArchivedRc<T, TF>

where T: ArchivePointee + PartialOrd<U> + ?Sized, U: ArchivePointee + ?Sized,

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

where T: ArchivePointee + CheckBytes<C> + LayoutRaw + ?Sized + 'static, T::ArchivedMetadata: CheckBytes<C>, F: Flavor, C: Fallible + ArchiveContext + SharedContext + ?Sized, C::Error: Source,

Available on crate feature bytecheck only.

fn verify(&self, context: &mut C) -> Result<(), C::Error>

Checks whether the invariants of this type are upheld by self.

impl<T, F> Eq for ArchivedRc<T, F>

where T: ArchivePointee + Eq + ?Sized,

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

where RelPtr<T>: Portable, PhantomData<F>: Portable,