Struct rkyv::RelPtr[−][src]

pub struct RelPtr<T: ArchivePointee + ?Sized> { /* fields omitted */ }

A pointer which resolves to relative to its position in memory.

See Archive for an example of creating one.

Implementations

impl<T: ArchivePointee + ?Sized> RelPtr<T>[src]

pub unsafe fn manual_check_bytes<'a, C: Fallible + ?Sized>(
    value: *const RelPtr<T>,
    context: &mut C
) -> Result<&'a Self, <T::ArchivedMetadata as CheckBytes<C>>::Error> where
    T: CheckBytes<C>,
    T::ArchivedMetadata: CheckBytes<C>, [src]

Checks the bytes of the given relative pointer.

This is done rather than implementing CheckBytes to force users to manually write their CheckBytes implementation since they need to also provide the ownership model of their memory.

Safety

The caller must guarantee that the given pointer is aligned and points to enough bytes to represent a RelPtr<T>.

impl<T: ArchivePointee + ?Sized> RelPtr<T>[src]

pub fn new(raw_ptr: RawRelPtr, metadata: T::ArchivedMetadata) -> Self[src]

Creates a new relative pointer from the given raw pointer and metadata.

Safety

The caller must guarantee that:

  • raw_ptr is a valid relative pointer in its final position
  • raw_ptr points to a valid value
  • metadata is valid metadata for the pointed value.

pub fn resolve_emplace<U: ArchiveUnsized<Archived = T> + ?Sized>(
    from: usize,
    to: usize,
    value: &U,
    metadata_resolver: U::MetadataResolver,
    out: &mut MaybeUninit<Self>
)[src]

Creates a relative pointer from one position to another.

Safety

The caller must guarantee that from is the position of the relative pointer and to is the position of some valid memory.

pub fn base(&self) -> *const u8[src]

Gets the base pointer for the relative pointer.

pub fn offset(&self) -> isize[src]

Gets the offset of the relative pointer.

pub fn metadata(&self) -> &T::ArchivedMetadata[src]

Gets the metadata of the relative pointer.

pub fn as_ptr(&self) -> *const T[src]

Calculates the memory address being pointed to by this relative pointer.

pub fn as_mut_ptr(&mut self) -> *mut T[src]

Returns an unsafe mutable pointer to the memory address being pointed to by this relative pointer.

Trait Implementations

impl<T: ArchivePointee + ?Sized> Debug for RelPtr<T> where
    T::ArchivedMetadata: Debug, [src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T: ?Sized> RefUnwindSafe for RelPtr<T> where
    T: RefUnwindSafe,
    <T as ArchivePointee>::ArchivedMetadata: RefUnwindSafe, 

impl<T: ?Sized> Send for RelPtr<T> where
    T: Send,
    <T as ArchivePointee>::ArchivedMetadata: Send, 

impl<T: ?Sized> Sync for RelPtr<T> where
    T: Sync,
    <T as ArchivePointee>::ArchivedMetadata: Sync, 

impl<T> !Unpin for RelPtr<T>

impl<T: ?Sized> UnwindSafe for RelPtr<T> where
    T: UnwindSafe,
    <T as ArchivePointee>::ArchivedMetadata: UnwindSafe, 

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T[src]

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

pub fn pointer_metadata(
    &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata[src]

Converts some archived metadata to the pointer metadata for itself.

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointee for T[src]

type Metadata = ()

The type for metadata in pointers and references to Self.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.