Struct hkRefPtr

#[repr(C)]
pub struct hkRefPtr<T>
where
    T: hkRefPtrCounted,
{ /* private fields */ }

A smart pointer with reference counting, modeled after Havok’s hkRefPtr.

Implementations

impl<T> hkRefPtr<T>

where T: hkRefPtrCounted,

pub const fn new() -> Self

Creates a new hkRefPtr with a nullptr.

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

Creates an hkRefPtr from a raw pointer.

pub fn reset(&mut self)

Resets the pointer, releasing the reference.

pub fn reset_with(&mut self, ptr: *mut T)

Replaces the current pointer with a new one.

pub const fn get(&self) -> *mut T

Returns the raw pointer.

pub const fn is_some(&self) -> bool

Checks if the pointer is not nullptr.

Trait Implementations

impl<T> Clone for hkRefPtr<T>

where T: hkRefPtrCounted,

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 for hkRefPtr<T>

where T: hkRefPtrCounted,

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

Formats the value using the given formatter.

impl<T> Default for hkRefPtr<T>

where T: hkRefPtrCounted,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for hkRefPtr<T>

where T: hkRefPtrCounted,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for hkRefPtr<T>

where T: hkRefPtrCounted,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Drop for hkRefPtr<T>

where T: hkRefPtrCounted,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> PartialEq<*mut T> for hkRefPtr<T>

where T: hkRefPtrCounted,

fn eq(&self, other: &*mut T) -> 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<T> PartialEq<NonNull<T>> for hkRefPtr<T>

where T: hkRefPtrCounted,

Equality operators with nullptr.

fn eq(&self, other: &NonNull<T>) -> 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<T> PartialEq for hkRefPtr<T>

where T: hkRefPtrCounted,

fn eq(&self, other: &Self) -> 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<T> Eq for hkRefPtr<T>

where T: hkRefPtrCounted,