Struct PtrConst

pub struct PtrConst<'mem>(/* private fields */);

A type-erased read-only pointer to an initialized value.

Cannot be null. May be dangling (for ZSTs)

Implementations

impl<'mem> PtrConst<'mem>

pub const fn new<T>(ptr: *const T) -> PtrConst<'mem>

Create a new opaque const pointer from a raw pointer

Safety

The pointer must be non-null, valid, aligned, and point to initialized memory of the correct type, and be valid for lifetime 'mem.

It’s encouraged to take the address of something with &raw const x, rather than &x

pub const fn as_byte_ptr(self) -> *const u8

Gets the underlying raw pointer as a byte pointer

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

Gets the underlying raw pointer as a pointer of type T

Safety

Must be called with the original type T that was used to create this pointer

pub const unsafe fn get<'borrow, T>(self) -> &'borrow T

where 'borrow: 'mem,

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

Safety

T must be the actual underlying type. You’re downcasting with no guardrails.

pub const unsafe fn field(self, offset: usize) -> PtrConst<'mem>

Returns a pointer with the given offset added

Safety

Offset must be within the bounds of the allocated memory, and the resulting pointer must be properly aligned.

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

Exposes core::ptr::read

Safety

T must be the actual underlying type of the pointed-to memory. The memory must be properly initialized and aligned for type T.

Trait Implementations

impl<'mem> Clone for PtrConst<'mem>

fn clone(&self) -> PtrConst<'mem>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'mem> Debug for PtrConst<'mem>

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

Formats the value using the given formatter.

impl<'mem> Hash for PtrConst<'mem>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IterItem for PtrConst<'_>

type Item<'a> = PtrConst<'a>

The output type of the iterator, bound by the lifetime 'a

impl<'mem> PartialEq for PtrConst<'mem>

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

impl<'mem> Eq for PtrConst<'mem>

impl Send for PtrConst<'_>

impl<'mem> StructuralPartialEq for PtrConst<'mem>

impl Sync for PtrConst<'_>