Struct rkyv::RawRelPtr

#[repr(transparent)]
pub struct RawRelPtr { /* fields omitted */ }

An untyped pointer which resolves relative to its position in memory.

Implementations

impl RawRelPtr

pub unsafe fn manual_check_bytes<'a, C: Fallible + ?Sized>(
    value: *const RawRelPtr,
    context: &mut C
) -> Result<&'a Self, Unreachable>

Checks the bytes of the given raw 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 RawRelPtr.

impl RawRelPtr

pub fn emplace(from: usize, to: usize, out: &mut MaybeUninit<Self>)

Emplaces a new relative pointer between the given positions and stores it in the given output.

pub fn null() -> Self

Creates a new relative pointer that has an offset of 0.

pub fn is_null(&self) -> bool

Checks whether the relative pointer is null.

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 as_ptr(&self) -> *const ()

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

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

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

Trait Implementations

impl Debug for RawRelPtr

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

Formats the value using the given formatter.