Struct PtrMut 

pub struct PtrMut { /* private fields */ }

A type-erased mutable pointer (wide pointer) holding a data pointer and metadata.

This is the base pointer type that can do everything. Uses TaggedPtr for the data pointer, which uses the low bit to distinguish wide vs thin pointers.

No lifetime parameter - safety is the caller’s responsibility.

Implementations

impl PtrMut

pub fn new<T: ?Sized>(ptr: *mut T) -> Self

Creates a new mutable pointer from a raw pointer to a (potentially unsized) object.

pub const fn new_sized<T: Sized>(ptr: *mut T) -> Self

Creates a new mutable pointer from a raw pointer to a sized type. This is const because sized types use thin pointers.

pub fn is_wide(self) -> bool

Returns true if this is a wide pointer

pub fn data_ptr(self) -> *mut u8

Returns the actual data pointer as *mut u8

pub unsafe fn with_offset(self, offset: usize) -> Self

Creates a new pointer with an offset added to the data pointer. Preserves the wide/thin tag and metadata.

Safety

Offset must be within bounds of the allocated memory.

pub const fn as_const(self) -> PtrConst

Convert to a PtrConst.

pub const fn as_uninit(self) -> PtrUninit

Convert to a PtrUninit.

pub fn as_byte_ptr(self) -> *const u8

Returns the underlying raw pointer as a const byte pointer.

Panics

Panics if this is a wide pointer.

pub fn as_mut_byte_ptr(self) -> *mut u8

Returns the underlying raw pointer as a mutable byte pointer.

Panics

Panics if this is a wide pointer.

pub unsafe fn get<'a, T: ?Sized>(self) -> &'a T

Borrows the underlying object as a reference of type T.

Safety

• T must be the actual underlying type
• The memory must be valid and initialized
• No mutable references may exist
• The returned reference must not outlive the actual data

pub unsafe fn as_mut<'a, T: ?Sized>(self) -> &'a mut T

Borrows the underlying object as a mutable reference of type T.

Safety

• T must be the actual underlying type
• The memory must be valid and initialized
• Caller must have exclusive access
• The returned reference must not outlive the actual data

pub unsafe fn as_ptr<T: ?Sized>(self) -> *const T

Gets the underlying raw pointer as a const pointer of type T.

Safety

Must be called with the original type T.

pub unsafe fn as_mut_ptr<T: ?Sized>(self) -> *mut T

Gets the underlying raw pointer as a mutable pointer of type T.

Safety

Must be called with the original type T.

pub unsafe fn read<T>(self) -> T

Reads the value from the pointer.

Safety

• T must be the actual underlying type
• The memory must be properly initialized

pub unsafe fn drop_in_place<T: ?Sized>(self) -> PtrUninit

Drops the value in place and returns a PtrUninit.

Safety

• T must be the actual underlying type
• The memory must be properly initialized

pub unsafe fn replace<T>(self, value: T) -> Self

Writes a value after dropping the existing one.

Safety

• The pointer must be properly aligned
• T must be the actual type
• The memory must already be initialized

pub unsafe fn field(self, offset: usize) -> PtrMut

Returns a pointer with the given offset added.

Safety

Offset must be within bounds of the allocated memory.

Trait Implementations

impl Clone for PtrMut

fn clone(&self) -> PtrMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtrMut

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

Formats the value using the given formatter.

impl From<PtrMut> for PtrConst

fn from(p: PtrMut) -> Self

Converts to this type from the input type.

impl From<PtrMut> for PtrUninit

fn from(p: PtrMut) -> Self

Converts to this type from the input type.

impl PartialEq for PtrMut

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PtrMut

impl Eq for PtrMut

impl StructuralPartialEq for PtrMut