Struct orengine::utils::ptr::Ptr

pub struct Ptr<T> { /* private fields */ }

A pointer wrapper.

Implementations

impl<T> Ptr<T>

pub fn new(value: T) -> Self

Create a new Ptr with the given value.

pub fn null() -> Self

Create a null Ptr.

pub fn is_null(&self) -> bool

Check if the pointer is null.

pub fn as_ptr(&self) -> *mut T

Get the raw pointer.

pub unsafe fn as_ref<'pointer>(self) -> &'pointer T

Get a reference to the value.

Panics

If the pointer is null.

pub unsafe fn as_mut<'pointer>(self) -> &'pointer mut T

Get a mutable reference to the value.

Panics

If the pointer is null.

pub fn as_u64(&self) -> u64

Returns the pointer as an u64. Use Ptr::from to convert it back.

pub unsafe fn drop_in_place(self)

Drop the value by calling the destructor, but not deallocate memory. To deallocate memory, use Ptr::deallocate.

pub unsafe fn deallocate(self)

Drop the value without calling a destructor.

pub unsafe fn drop_and_deallocate(self)

Drop the value by calling the destructor and then deallocate.

pub unsafe fn read(self) -> T

Return the value. It will not lead to the pointer value being dropped.

Panics

If the pointer is null.

pub unsafe fn write(self, value: T)

Set the value. Does not call drop the old value.

Panics

If the pointer is null.

Write with drop

Call Ptr::write_with_drop instead.

pub unsafe fn write_with_drop(self, value: T)

Set the value. Drops the old value.

Panics

If the pointer is null.

Write no drop

Call Ptr::write instead.

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

Replace the value, returning the old value.

Panics

If the pointer is null.

Trait Implementations

impl<T> Clone for Ptr<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ptr<T>

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

Formats the value using the given formatter.

impl<T> From<&mut T> for Ptr<T>

fn from(ptr: &mut T) -> Self

Converts to this type from the input type.

impl<T> From<u64> for Ptr<T>

fn from(ptr: u64) -> Self

Converts to this type from the input type.

impl<T> From<usize> for Ptr<T>

fn from(ptr: usize) -> Self

Converts to this type from the input type.

impl<T> Copy for Ptr<T>

impl<T: Send> Send for Ptr<T>

impl<T: Sync> Sync for Ptr<T>