Struct rkyv::RelPtr

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>

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>, 

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.

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

pub unsafe fn new(raw_ptr: RawRelPtr, metadata: T::ArchivedMetadata) -> Self

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

Safety

raw_ptr must be a valid relative pointer in its final position and must point to a valid value. metadata must be valid metadata for the pointed value.

pub unsafe fn resolve<U: ArchiveUnsized<Archived = T> + ?Sized>(
    from: usize,
    to: usize,
    value: &U,
    metadata_resolver: U::MetadataResolver
) -> Self

Creates a relative pointer from one position to another.

Safety

from must be the position of the relative pointer and to must be the position of some valid memory.

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

Gets the base pointer for the relative pointer.

pub fn offset(&self) -> isize

Gets the offset of the relative pointer.

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

Gets the metadata of the relative pointer.

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

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

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

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, 

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

Formats the value using the given formatter.