Struct rel_core::rel_ptr::RelPtr

#[repr(C)]
pub struct RelPtr<T: BasisPointee<B> + ?Sized, R: Region, B: Basis> { /* private fields */ }

A pointer that stores the difference between itself and its pointee.

Implementations

impl<T: BasisPointee<B> + ?Sized, R: Region, B: Basis> RelPtr<T, R, B>

pub fn base(this: Ref<'_, Self>) -> *const u8

Returns the base pointer for the relative pointer.

The base of the relative pointer is always its location in memory.

pub fn base_mut(this: Mut<'_, Self>) -> *mut u8

Returns the mutable base pointer for the relative pointer.

The base of the relative pointer is always its location in memory.

pub fn offset(&self) -> isize

Returns the offset of the relative pointer’s target from its base.

pub fn is_null(&self) -> bool

Returns whether the offset of the relative pointer is 0.

pub fn metadata(&self) -> Option<T::Metadata>

Returns the metadata of the relative pointer’s pointee if it is not null.

pub unsafe fn metadata_unchecked(&self) -> T::Metadata

Returns the metadata of the relative pointer’s pointee.

Safety

The relative pointer must not be null.

pub fn as_ptr(this: Ref<'_, Self>) -> Option<*const T>

Returns the target of the relative pointer if it is not null.

pub unsafe fn as_ptr_unchecked(this: Ref<'_, Self>) -> *const T

Returns the target of the relative pointer.

Safety

The relative pointer must not be null.

pub unsafe fn as_ref<'a>(this: Ref<'_, Self>) -> Ref<'a, T>

Returns a Ref to the target of the relative pointer.

Safety

• this must be non-null, properly aligned, and valid for reads.
• this must not alias any other mutable references for 'a.
• The value pointed to by this must be initialized.

pub fn as_mut_ptr(this: Mut<'_, Self>) -> Option<*mut T>

Returns a mutable pointer to the target of the relative pointer if it is not null.

pub unsafe fn as_mut_ptr_unchecked(this: Mut<'_, Self>) -> *mut T

Returns a mutable pointer to the target of the relative pointer.

Safety

this must not be null.

pub unsafe fn as_mut<'a>(this: Mut<'_, Self>) -> Mut<'a, T>

Returns a Mut to the target of the relative pointer.

Safety

• this must be non-null, properly aligned, and valid for reads and writes.
• this must not alias any other accessible references for 'a.
• The pointee of this must be initialized and immovable.

pub fn set(this: Mut<'_, Self>, ptr: In<*mut T, R>)

Sets the pointee of this RelPtr.

Trait Implementations

impl<T: BasisPointee<B> + ?Sized, R: Region, B: Basis> DropRaw for RelPtr<T, R, B>where
    B::Isize: DropRaw,
    MaybeUninit<<T as BasisPointee<B>>::BasisMetadata>: DropRaw,
    PhantomData<(*mut T, R)>: DropRaw,
    PhantomPinned: DropRaw,

unsafe fn drop_raw(this: Mut<'_, Self>)

Drops the value pointed to by this.

impl<T, R, B> Emplace<RelPtr<T, R, B>, R> for In<*mut T, R>where
    T: BasisPointee<B> + Pointee + ?Sized,
    R: Region,
    B: Basis,

fn emplaced_meta(&self) -> <RelPtr<T, R, B> as Pointee>::Metadata

Returns the metadata of the T that this emplaces.

unsafe fn emplace_unsized_unchecked(self, out: In<Slot<'_, RelPtr<T, R, B>>, R>)

Emplaces a value into a given slot within some memory region.

impl<T, R, B> Emplace<RelPtr<T, R, B>, R> for Nullwhere
    T: BasisPointee<B> + ?Sized,
    R: Region,
    B: Basis,

fn emplaced_meta(&self) -> <RelPtr<T, R, B> as Pointee>::Metadata

Returns the metadata of the T that this emplaces.

unsafe fn emplace_unsized_unchecked(self, out: In<Slot<'_, RelPtr<T, R, B>>, R>)

Emplaces a value into a given slot within some memory region.

impl<T, R, B> Move<R> for RelPtr<T, R, B>where
    T: BasisPointee<B> + ?Sized,
    R: Region,
    B: Basis,

unsafe fn move_unsized_unchecked(
    this: In<Val<'_, Self>, R>,
    out: In<Slot<'_, Self>, R>
)

Moves a value into a given slot within some memory region.

impl<T, R, B> Pinned<R> for RelPtr<T, R, B>where
    T: BasisPointee<B> + Pointee + ?Sized,
    R: Region,
    B: Basis,

impl<T: BasisPointee<B> + ?Sized, R: Region, B: Basis> Portable for RelPtr<T, R, B>where
    B::Isize: Portable,
    MaybeUninit<<T as BasisPointee<B>>::BasisMetadata>: Portable,
    PhantomData<(*mut T, R)>: Portable,
    PhantomPinned: Portable,