Struct rkyv::rel_ptr::RelPtr

#[repr(C)]
pub struct RelPtr<T: ArchivePointee + ?Sized, O> { /* private fields */ }

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

This is a strongly-typed version of RawRelPtr.

See Archive for an example of creating one.

Implementations

impl<T, O: Offset> RelPtr<T, O>

pub unsafe fn try_emplace<E: Error>( from: usize, to: usize, out: *mut Self ) -> Result<(), E>

Attempts to create a relative pointer from one position to another.

Safety

out must point to a Self that is valid for reads and writes.

pub unsafe fn emplace(from: usize, to: usize, out: *mut Self)

Creates a relative pointer from one position to another.

Panics

• If the offset between from and to does not fit in an isize
• If the offset between from and to exceeds the offset storage

Safety

out must point to a Self that is valid for reads and writes.

impl<T: ArchivePointee + ?Sized, O: Offset> RelPtr<T, O>

where T::ArchivedMetadata: Default,

pub unsafe fn try_emplace_null<E: Error>( pos: usize, out: *mut Self ) -> Result<(), E>

Attempts to create a null relative pointer with default metadata.

Safety

out must point to a Self that is valid for reads and writes.

pub unsafe fn emplace_null(pos: usize, out: *mut Self)

Creates a null relative pointer with default metadata.

Panics

• If an offset of 0 does not fit in an isize
• If an offset of 0 exceeds the offset storage

Safety

out must point to a Self that is valid for reads and writes.

impl<T: ArchivePointee + ?Sized, O: Offset> RelPtr<T, O>

pub unsafe fn try_emplace_unsized<E: Error>( from: usize, to: usize, metadata: T::ArchivedMetadata, out: *mut Self ) -> Result<(), E>

Attempts to create a relative pointer from one position to another.

Safety

out must point to a Self that is valid for reads and writes.

pub unsafe fn emplace_unsized( from: usize, to: usize, metadata: T::ArchivedMetadata, out: *mut Self )

Creates a relative pointer from one position to another.

Panics

• If the offset between from and to does not fit in an isize
• If the offset between from and to exceeds the offset storage

Safety

out must point to a Self that is valid for reads and writes.

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

Gets the base pointer for the relative pointer.

pub fn offset(&self) -> isize

Gets the offset of the relative pointer from its base.

pub fn is_null(&self) -> bool

Gets whether the offset of the relative pointer is 0.

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

Gets the metadata of the relative pointer.

pub unsafe fn as_ptr(&self) -> *mut T

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

Safety

The offset of this relative pointer, when added to its base, must be located in the same allocated object as it.

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

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

This method is a safer but potentially slower version of as_ptr.

Trait Implementations

impl<T: ArchivePointee + ?Sized, O, __C: Fallible + ?Sized> CheckBytes<__C> for RelPtr<T, O>

where <__C as Fallible>::Error: Trace, RawRelPtr<O>: CheckBytes<__C>, T::ArchivedMetadata: CheckBytes<__C>, PhantomData<T>: 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: ArchivePointee + ?Sized, O: Debug> Debug for RelPtr<T, O>

where T::ArchivedMetadata: Debug,

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

Formats the value using the given formatter.

impl<T: ArchivePointee + ?Sized, O: Offset> Pointer for RelPtr<T, O>

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

Formats the value using the given formatter.

impl<T, O> Portable for RelPtr<T, O>

where T: ArchivePointee + Portable + ?Sized, RawRelPtr<O>: Portable, T::ArchivedMetadata: Portable, PhantomData<T>: Portable,