Struct rkyv::RelPtr

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

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

See Archive for an example of creating one.

Implementations

impl RelPtr

pub unsafe fn new(from: usize, to: usize) -> 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 offset(&self) -> isize

Gets the offset of the relative pointer.

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

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

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

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

Trait Implementations

impl CheckBytes<ArchiveContext> for RelPtr

type Error = Unreachable

The error that may result from validating the type.

pub unsafe fn check_bytes<'a>(
    bytes: *const u8,
    context: &mut ArchiveContext
) -> Result<&'a Self, Self::Error>

Checks whether the given bytes represent a valid value within the given context.

impl Debug for RelPtr

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

Formats the value using the given formatter.