PtrUninit

Struct PtrUninit 

Source
pub struct PtrUninit<'mem>(/* private fields */);
Expand description

A type-erased pointer to an uninitialized value

Implementations§

Source§

impl<'mem> PtrUninit<'mem>

Source

pub unsafe fn copy_from<'src>( self, src: PtrConst<'src>, shape: &'static Shape, ) -> Result<PtrMut<'mem>, UnsizedError>

Copies memory from a source pointer into this location and returns PtrMut

§Safety
  • The source pointer must be valid for reads of len bytes
  • This pointer must be valid for writes of len bytes and properly aligned
  • The regions may not overlap
Source

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

Create a new opaque pointer from a mutable pointer

This is safe because it’s generic over T

Source

pub fn from_maybe_uninit<T>(borrow: &'mem mut MaybeUninit<T>) -> Self

Creates a new opaque pointer from a reference to a core::mem::MaybeUninit

The pointer will point to the potentially uninitialized contents

This is safe because it’s generic over T

Source

pub unsafe fn assume_init(self) -> PtrMut<'mem>

Assumes the pointer is initialized and returns an Opaque pointer

§Safety

The pointer must actually be pointing to initialized memory of the correct type.

Source

pub unsafe fn put<T>(self, value: T) -> PtrMut<'mem>

Write a value to this location and convert to an initialized pointer

§Safety

The pointer must be properly aligned for T and point to allocated memory that can be safely written to.

Source

pub fn as_mut_byte_ptr(self) -> *mut u8

Returns the underlying raw pointer as a byte pointer

Source

pub fn as_byte_ptr(self) -> *const u8

Returns the underlying raw pointer as a const byte pointer

Source

pub unsafe fn field_uninit_at(self, offset: usize) -> PtrUninit<'mem>

Returns a pointer with the given offset added

§Safety

Offset is within the bounds of the allocated memory

Source

pub unsafe fn field_init_at(self, offset: usize) -> PtrMut<'mem>

Returns a pointer with the given offset added, assuming it’s initialized

§Safety

The pointer plus offset must be:

  • Within bounds of the allocated object
  • Properly aligned for the type being pointed to
  • Point to initialized data of the correct type

Trait Implementations§

Source§

impl<'mem> Clone for PtrUninit<'mem>

Source§

fn clone(&self) -> PtrUninit<'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<'mem> Debug for PtrUninit<'mem>

Source§

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

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

impl<'mem, T> From<TypedPtrUninit<'mem, T>> for PtrUninit<'mem>

Source§

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

Converts to this type from the input type.
Source§

impl<'mem> Copy for PtrUninit<'mem>

Auto Trait Implementations§

§

impl<'mem> Freeze for PtrUninit<'mem>

§

impl<'mem> RefUnwindSafe for PtrUninit<'mem>

§

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

§

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

§

impl<'mem> Unpin for PtrUninit<'mem>

§

impl<'mem> !UnwindSafe for PtrUninit<'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.