PtrConst

Struct PtrConst 

Source
pub struct PtrConst<'mem> { /* private fields */ }
Expand description

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

Like PtrConst, but for unsized types where metadata is needed. Cannot be null (but may be dangling for ZSTs). The lifetime 'mem represents the borrow of the underlying memory, which must remain valid and initialized.

Implementations§

Source§

impl<'mem> PtrConst<'mem>

Source

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

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

§Arguments
  • ptr - Raw pointer to the object. Can be a pointer to a DST (e.g., slice, trait object).
§Panics

Panics if a thin pointer is provided where a wide pointer is expected.

Source

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

Returns the underlying data pointer as a pointer to u8 (the address of the object).

Source

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

Borrows the underlying object as a reference of type T.

§Safety
  • T must be the actual underlying (potentially unsized) type of the pointed-to memory.
  • The memory must remain valid and not be mutated while this reference exists.
  • The pointer must be correctly aligned and point to a valid, initialized value for type T.
Source

pub const unsafe fn as_ptr<T: ?Sized>(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

Source

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.

Source

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§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PtrConst<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'mem, T: ?Sized> From<TypedPtrConst<'mem, T>> for PtrConst<'mem>

Source§

fn from(ptr: TypedPtrConst<'mem, T>) -> Self

Converts to this type from the input type.
Source§

impl IterItem for PtrConst<'_>

Source§

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

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

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

Source§

fn eq(&self, other: &PtrConst<'mem>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'mem> Copy for PtrConst<'mem>

Source§

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

Source§

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

Auto Trait Implementations§

§

impl<'mem> Freeze for PtrConst<'mem>

§

impl<'mem> RefUnwindSafe for PtrConst<'mem>

§

impl<'mem> !Send for PtrConst<'mem>

§

impl<'mem> !Sync for PtrConst<'mem>

§

impl<'mem> Unpin for PtrConst<'mem>

§

impl<'mem> UnwindSafe for PtrConst<'mem>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.