Struct PtrConst 

pub struct PtrConst { /* private fields */ }

A type-erased read-only pointer.

Wraps PtrMut but only exposes read methods. No lifetime parameter.

Implementations

impl PtrConst

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

Creates a new const pointer from a raw pointer.

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

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

pub fn new_wide(data: *const u8, metadata: *const ()) -> Self

Create a wide pointer from raw data pointer and metadata.

pub fn is_wide(self) -> bool

Returns true if this is a wide pointer.

pub fn raw_ptr(self) -> *const u8

Returns the raw data pointer.

pub fn as_byte_ptr(self) -> *const u8

Returns the underlying data pointer as a 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
• 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 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 field(self, offset: usize) -> PtrConst

Returns a pointer with the given offset added.

Safety

Offset must be within bounds of the allocated memory.

pub unsafe fn into_mut(self) -> PtrMut

Convert to a mutable pointer.

Safety

Caller must ensure they have exclusive access.

Trait Implementations

impl Clone for PtrConst

fn clone(&self) -> PtrConst

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtrConst

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 IterItem for PtrConst

type Item = PtrConst

The output type of the iterator

impl PartialEq for PtrConst

fn eq(&self, other: &PtrConst) -> 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 PtrConst

impl Eq for PtrConst

impl StructuralPartialEq for PtrConst