Struct rel_ptr::RelPtr

pub struct RelPtr<T: ?Sized + MetaData, I: Delta = isize>(_, _, _);

This represents a relative pointers

A relative pointer stores an offset, and uses its that in combination with its current position in memory to point to a value

See crate documentation for more information

Methods

impl<T: ?Sized + MetaData, I: Delta> RelPtr<T, I>

pub fn null() -> Self

A null relative pointer has an offset of 0, (points to itself)

pub fn is_null(&self) -> bool

Check if relative pointer is null

pub fn set(&mut self, value: &T) -> Result<(), I::Error>

set the offset of a relative pointer, if the offset cannot be calculated using the given Delta, then None will be returned, and there will be no change to the offset

pub unsafe fn set_unchecked(&mut self, value: &T)

set the offset of a relative pointer, if the offset cannot be calculated using the given Delta, then None will be returned, and there will be no change to the offset

Safety

if the offset is out of bounds for the given Delta then it's value is UB

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

Converts the relative pointer into a normal raw pointer

Note: if self.is_null() then a null pointer will be returned

Safety

You must ensure that if RelPtr::set was called successfully before calling this function and that the value pointed to does not change it's offset relative to RelPtr

if RelPtr::set was never called successfully, this function is safe and returns None because the only way to construct a RelPtr is to make a null ptr and change it through RelPtr::set

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

Converts the relative pointer into a normal raw pointer

Safety

You must ensure that RelPtr::set was called successfully before calling this function and that the value pointed to does not change it's offset relative to RelPtr

if RelPtr::set was never called successfully, this function is UB

pub unsafe fn as_non_null(&self) -> Option<NonNull<T>>

Converts the relative pointer into a normal raw pointer

Safety

Same as RelPtr::as_raw

pub unsafe fn as_non_null_unchecked(&self) -> NonNull<T>

Converts the relative pointer into a normal raw pointer

Safety

Same as RelPtr::as_raw_unchecked

pub unsafe fn as_ref(&self) -> Option<&T>

Gets a reference from the relative pointer, if the relative pointer is null, then None is returned

Safety

Same as RelPtr::as_raw

pub unsafe fn as_mut(&mut self) -> Option<&mut T>

Gets a mutable reference from the relative pointer, if the relative pointer is null, then None is returned

Safety

Same as RelPtr::as_raw

pub unsafe fn as_ref_unchecked(&self) -> &T

Gets a reference from the relative pointer

Safety

Same as RelPtr::as_raw_unchecked

pub unsafe fn as_mut_unchecked(&mut self) -> &mut T

Gets a mutable reference from the relative pointer

Safety

Same as RelPtr::as_raw_unchecked

Trait Implementations

impl<T: ?Sized + MetaData, I: Delta> Copy for RelPtr<T, I>

impl<T: ?Sized + MetaData, I: Delta> PartialEq<RelPtr<T, I>> for RelPtr<T, I>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ?Sized + MetaData, I: Delta> Clone for RelPtr<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: ?Sized + MetaData, I: Delta> Eq for RelPtr<T, I>