Struct BSTSmartPointer

#[repr(C)]
pub struct BSTSmartPointer<T, M = BSTSmartPointerIntrusiveRefCount>
where
    T: BSIntrusiveRefCountedTrait,
    M: ManageBSTSmartPointer,
{ /* private fields */ }

Smart pointer with customizable reference management.

This smart pointer optionally manages reference counts depending on the M parameter.

Panics

Dereferencing a null pointer via Deref or DerefMut will panic. Use [as_ref] or [is_null] to avoid this panic.

Implementations

impl<T, M> BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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

Creates a new smart pointer from a raw pointer.

Safety

The pointer must be created from TESBox(MemoryManager::allocate).

pub fn from_non_null(ptr: NonNull<T>) -> Self

Creates a new smart pointer from a raw pointer.

pub fn reset(&mut self)

Replaces the internal pointer with null and releases the old object.

After calling this, [is_null] returns true.

pub fn from_box(value: TESBox<T>) -> Self

Creates a smart pointer from a TESBox, taking ownership.

pub const fn as_ref(&self) -> Option<&T>

Returns an immutable reference to the managed object, or None if the pointer is null.

Use this to safely access the internal object without risking a panic.

pub const fn as_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the managed object, or None if the pointer is null.

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

Returns the raw pointer to the managed object.

pub const fn is_null(&self) -> bool

Returns true if the internal pointer is null.

Trait Implementations

impl<T, M> Clone for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, M> Debug for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait + Debug, M: ManageBSTSmartPointer,

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

Formats the value using the given formatter.

impl<T, M> Default for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

fn default() -> Self

Returns the “default value” for a type.

impl<T, M> Deref for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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

Dereferences the smart pointer to the managed object.

Panics

Panics if the internal pointer is null.

type Target = T

The resulting type after dereferencing.

impl<T, M> DerefMut for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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

Dereferences the smart pointer mutably.

Panics

Panics if the internal pointer is null.

impl<T, M> Drop for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, M> PartialEq<*mut T> for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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, M> PartialEq<NonNull<T>> for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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, M> PartialEq<Option<*mut T>> for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

fn eq(&self, other: &Option<*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, M> PartialEq for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,

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, M> Eq for BSTSmartPointer<T, M>

where T: BSIntrusiveRefCountedTrait, M: ManageBSTSmartPointer,